docs + deps

README.md

@@ -1,2 +1,54 @@
 # personal-next-template
 🍪 | My personal starter for NextJS: TS, Tailwind, HeadlessUI, ESLint, Prettier, Git Hooks
+
+## Features
+
+- Next 14 with page routes
+  - React 18
+  - TypeScript
+- Tailwind CSS 3
+- Headless UI
+- Built-in code quality tools
+  - Linting & Code Formatting
+    - ESLint
+    - Prettier
+  - GitHub Actions
+    - Auto-lint on push
+    - Auto link issue with PR
+- Deployment
+  - Optimized Dockerfile
+  - Pre-production checklist
+
+## Getting Started
+
+### 1. Clone the repository
+
+You can use any of the following way:
+
+- Using the 'Use this repo as template' button
+- Using `degit`:
+
+  ```bash
+  pnpx degit angeloanan/personal-next-template YOUR_APP_NAME
+  ```
+
+### 2. Install dependencies
+
+```bash
+pnpm i
+```
+
+### 3. Run the development server
+
+```bash
+pnpm dev
+```
+
+Open [localhost:3000](http://localhost:3000) with your browser to see the result. You can start editing the page by modifying [`src/pages/index.tsx`](./src/pages/index.tsx).
+
+## Pre-production Checklist
+
+- [ ] Whitelabel package.json with your project information (enable `private: true` if needed)
+- [ ] Lock dependencies version to major
+- [ ] Replace SEO configurations at [next-seo.config.js](./next-seo.config.js) and [next-sitemap.config.js](./next-sitemap.config.js)
+- [ ] Setup CI/CD that'll automatically deploy the app on update

package.json

@@ -16,9 +16,9 @@
   "dependencies": {
     "@fontsource-variable/inter": "^5.0.15",
     "@headlessui/react": "^1.7.17",
-    "@next/bundle-analyzer": "^14.0.1",
+    "@next/bundle-analyzer": "^14.0.2",
     "autoprefixer": "^10.4.16",
-    "next": "^14.0.1",
+    "next": "^14.0.2",
     "next-seo": "^6.4.0",
     "postcss": "^8.4.31",
     "react": "^18.2.0",
@@ -28,17 +28,17 @@
     "tw-merge": "0.0.1-alpha.3"
   },
   "devDependencies": {
-    "@types/node": "^20.8.10",
-    "@types/react": "^18.2.34",
-    "@types/react-dom": "^18.2.14",
+    "@types/node": "^20.9.0",
+    "@types/react": "^18.2.37",
+    "@types/react-dom": "^18.2.15",
     "eslint": "8.53.0",
-    "eslint-config-next": "14.0.1",
+    "eslint-config-next": "14.0.2",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "5.0.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "next-sitemap": "^4.2.3",
-    "prettier": "^3.0.3",
-    "prettier-plugin-tailwindcss": "^0.5.6",
+    "prettier": "^3.1.0",
+    "prettier-plugin-tailwindcss": "^0.5.7",
     "typescript": "^5.2.2"
   }
 }