init

Signed-off-by: rajput-hemant <[email protected]>

.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.env.example

@@ -0,0 +1,48 @@
+# -----------------------------------------------------------------------------
+# App
+# -----------------------------------------------------------------------------
+NEXT_PUBLIC_APP_URL=http://localhost:3000
+SKIP_ENV_VALIDATION=false # Set to true to disable env validation
+
+#-----------------------------------------------------------------------------------------------
+# NextAuth
+#-----------------------------------------------------------------------------------------------
+# You can generate a new secret on the command line with:
+# openssl rand -base64 32
+#-----------------------------------------------------------------------------------------------
+NEXTAUTH_URL=http://localhost:3000
+NEXTAUTH_SECRET=
+
+
+#-----------------------------------------------------------------------------------------------
+# Google Credentials
+#-----------------------------------------------------------------------------------------------
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRET=
+
+#-----------------------------------------------------------------------------------------------
+# Github Credentials
+#-----------------------------------------------------------------------------------------------
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+
+#-----------------------------------------------------------------------------------------------
+# Discord Credentials
+#-----------------------------------------------------------------------------------------------
+DISCORD_CLIENT_ID=
+DISCORD_CLIENT_SECRET=
+
+
+#-----------------------------------------------------------------------------------------------
+# Database
+#-----------------------------------------------------------------------------------------------
+DATABASE_URL=
+
+
+#-----------------------------------------------------------------------------------------------
+# Upstash Redis (https://console.upstash.com)
+#-----------------------------------------------------------------------------------------------
+UPSTASH_REDIS_REST_URL=
+UPSTASH_REDIS_REST_TOKEN=
+ENABLE_RATE_LIMITING=false
+RATE_LIMITING_REQUESTS_PER_SECOND=20

.eslintignore

@@ -0,0 +1,6 @@
+dist/*
+.next/*
+.cache
+public
+node_modules
+*.esm.js

.eslintrc

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json.schemastore.org/eslintrc",
+  "root": true,
+  "extends": [
+    "eslint:recommended",
+    "next/core-web-vitals",
+    "prettier",
+    "plugin:tailwindcss/recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "plugins": ["tailwindcss"],
+  "rules": {
+    "@next/next/no-html-link-for-pages": "off",
+    "react/jsx-key": "warn",
+    "tailwindcss/no-custom-classname": "off",
+    "tailwindcss/classnames-order": "warn",
+    "@typescript-eslint/consistent-type-imports": "warn",
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_",
+        "caughtErrorsIgnorePattern": "^_"
+      }
+    ]
+  },
+  "settings": {
+    "tailwindcss": {
+      "callees": ["cn"],
+      "config": "tailwind.config.js"
+    },
+    "next": {
+      "rootDir": ["./"]
+    }
+  },
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parser": "@typescript-eslint/parser"
+    }
+  ]
+}

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  build:
+    name: Run Type Check, Linters & Tests
+    runs-on: ubuntu-latest
+
+    env:
+      SKIP_ENV_VALIDATION: true
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun i
+
+      - name: Check types
+        run: bun run type-check
+
+      - name: Check linting
+        run: bun run lint
+
+      - name: Run tests
+        run: bun test
+
+      - name: Check commits messages
+        uses: wagoid/commitlint-github-action@v5

.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.prettierignore

@@ -0,0 +1,10 @@
+cache
+.cache
+public
+CHANGELOG.md
+.yarn
+dist
+node_modules
+.next
+build
+.contentlayer

.prettierrc

@@ -0,0 +1,23 @@
+{
+  "endOfLine": "lf",
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "plugins": ["@ianvs/prettier-plugin-sort-imports"],
+  "importOrder": [
+    "^(react/(.*)$)|^(react$)",
+    "^(next/(.*)$)|^(next$)",
+    "<THIRD_PARTY_MODULES>",
+    "",
+    "^types$",
+    "^@/types/(.*)$",
+    "^@/store/?(.*)$",
+    "^@/config/(.*)$",
+    "^@/lib/(.*)$",
+    "^@/hooks/?(.*)$",
+    "^@/components/(.*)$",
+    "^[./]"
+  ],
+  "importOrderParserPlugins": ["typescript", "jsx", "decorators-legacy"]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Hemant Rajput
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,134 @@
+<div align=center>
+
+[![ntl-badge]][ntl-link] ![views] ![stars] ![forks] ![issues] ![license] ![repo-size]
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="public/nextjs-light.svg">
+  <source media="(prefers-color-scheme: light)" srcset="public/nextjs-dark.svg">
+  <img alt="Next.js">
+</picture>
+
+# Next.js Starter Template
+
+### A Minimal Next.js Starter Template with TypeScript, Tailwind CSS, and pre-configured with ESLint, Prettier, and Husky.
+
+</div>
+
+## Features
+
+- ⚡ **[Next.js](https://nextjs.org/)** - A React Framework for Production
+- 🔥 **[App Router](https://nextjs.org/docs/app)** - It is a new paradigm for building applications using React's latest features.
+- 🎨 **[Tailwind CSS](https://tailwindcss.com/)** - A Utility-First CSS Framework for Rapid UI Development
+- 📦 **[TypeScript](https://www.typescriptlang.org/)** - A typed superset of JavaScript that compiles to plain JavaScript
+- 📝 **[ESLint](https://eslint.org/)** - The pluggable linting utility for JavaScript and JSX
+- 🛠 **[Prettier](https://prettier.io/)** - An opinionated code formatter
+- 🐶 **[Husky](https://typicode.github.io/husky/#/)** - A tool that makes Git hooks easy
+- 🚫 **[lint-staged](https://github.com/okonet/lint-staged)** - Run linters against staged git files
+- 📄 **[commitlint](https://commitlint.js.org/#/)** - Lint commit messages
+- 📦 **[bun](https://bun.sh)** - A JavaScript runtime w/ Fast, disk space efficient package manager
+
+## Getting Started
+
+```bash
+bun create next-app -e "https://github.com/rajput-hemant/nextjs-template" <project-name>
+
+npx create-next-app -e "https://github.com/rajput-hemant/nextjs-template" <project-name>
+```
+
+<p align="center" style="font-weight: bold;">OR</p>
+
+**Install `degit` globally**
+
+```bash
+bun i -g degit || pnpm i -g degit || yarn global add degit || npm i -g degit
+```
+
+**Create a new project from this template**
+
+```bash
+degit rajput-hemant/nextjs-template <project-name>
+cd <project-name>
+```
+
+**Install dependencies**
+
+```bash
+bun i || pnpm i || yarn || npm i
+```
+
+**Initialize a new git repository _(Optional)_:**
+
+```bash
+git init
+git add .
+git commit --no-verify -m "init"
+```
+
+## Integrations
+
+[Kirimase](https://kirimase.dev) is a Next.js CLI tool that accelerates full-stack app development. It seamlessly integrates packages like ORM (Prisma or Drizzle), authentication (Auth.js, Clerk, Lucia, Kinde), UI components (Shadcn-UI), payments (Stripe), and email (Resend), following best practices.
+
+To add integrations to your project, run:
+
+```bash
+kirimase init
+```
+
+## Available Scripts
+
+In the project directory, you can run:
+
+| **Script**   | **Description**                                      |
+| ------------ | ---------------------------------------------------- |
+| `dev`        | Runs the app in the development mode.                |
+| `build`      | Builds the app for production to the `.next` folder. |
+| `start`      | Runs the built app in the production mode.           |
+| `preview`    | Builds and serves the app in the production mode.    |
+| `lint`       | Runs next lint on the project.                       |
+| `type-check` | Runs TypeScript type checker.                        |
+| `fmt`        | Formats the code with Prettier.                      |
+| `fmt:check`  | Checks if the code is formatted with Prettier.       |
+| `prepare`    | Installs husky git hooks.                            |
+
+## After Installation Checklist
+
+- [ ] Update `package.json` with your project details.
+- [ ] Update `README.md` with your project details.
+- [ ] Update `LICENSE` with your name and year.
+
+## Switching Package Manager
+
+This template uses [bun](https://bun.sh/docs/cli/install) as the default package manager. If you want to use `pnpm`, `npm` or `yarn`, you need to remove the `bun.lockb` file and run `pnpm i`, `npm i` or `yarn` to generate the lock file for the respective package manager.
+
+## Deployments
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/rajput-hemant/nextjs-template)
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/rajput-hemant/nextjs-template)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contributors:
+
+<div align=center>
+
+[![][contributors]][contributors-graph]
+
+_Note: It may take up to 24h for the [contrib.rocks][contrib-rocks] plugin to update because it's refreshed once a day._
+
+</div>
+
+<!----------------------------------{ Labels }--------------------------------->
+
+[views]: https://komarev.com/ghpvc/?username=nextjs-template&label=view%20counter&color=red&style=flat
+[repo-size]: https://img.shields.io/github/repo-size/rajput-hemant/nextjs-template
+[issues]: https://img.shields.io/github/issues-raw/rajput-hemant/nextjs-template
+[license]: https://img.shields.io/github/license/rajput-hemant/nextjs-template
+[forks]: https://img.shields.io/github/forks/rajput-hemant/nextjs-template?style=flat
+[stars]: https://img.shields.io/github/stars/rajput-hemant/nextjs-template
+[contributors]: https://contrib.rocks/image?repo=rajput-hemant/nextjs-template&max=500
+[contributors-graph]: https://github.com/rajput-hemant/nextjs-template/graphs/contributors
+[contrib-rocks]: https://contrib.rocks/preview?repo=rajput-hemant%2Fnextjs-template
+[ntl-badge]: https://api.netlify.com/api/v1/badges/6955f80c-0747-4947-a344-e7c647012cbe/deploy-status
+[ntl-link]: https://app.netlify.com/sites/react-template-vite/deploys