-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
489 additions
and
483 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| target-branch: "base" | ||
| groups: | ||
| updates: | ||
| applies-to: version-updates | ||
| patterns: | ||
| - "*" | ||
| update-types: | ||
| - "minor" | ||
| - "patch" | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| target-branch: "nextui" | ||
| groups: | ||
| updates: | ||
| applies-to: version-updates | ||
| patterns: | ||
| - "*" | ||
| update-types: | ||
| - "minor" | ||
| - "patch" | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| target-branch: "typesafe-env" | ||
| groups: | ||
| updates: | ||
| applies-to: version-updates | ||
| patterns: | ||
| - "*" | ||
| update-types: | ||
| - "minor" | ||
| - "patch" | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| target-branch: "next-auth" | ||
| groups: | ||
| updates: | ||
| applies-to: version-updates | ||
| patterns: | ||
| - "*" | ||
| update-types: | ||
| - "minor" | ||
| - "patch" | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| target-branch: "drizzle" | ||
| groups: | ||
| updates: | ||
| applies-to: version-updates | ||
| patterns: | ||
| - "*" | ||
| update-types: | ||
| - "minor" | ||
| - "patch" | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| target-branch: "main" | ||
| groups: | ||
| updates: | ||
| applies-to: version-updates | ||
| patterns: | ||
| - "*" | ||
| update-types: | ||
| - "minor" | ||
| - "patch" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| src/db/migrations/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License Copyright (c) 2024 w3cj | ||
|
|
||
| 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 | ||
| (including the next paragraph) 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,114 @@ | ||
| # Next Start | ||
|
|
||
| A basic Next.js starter with sensible defaults for eslint, prettier, typescript and vscode. | ||
| A basic Next.js starter. | ||
|
|
||
| - [Next Start](#next-start) | ||
| - [Stack](#stack) | ||
| - [Branches](#branches) | ||
| - [Setup](#setup) | ||
| - [Resources](#resources) | ||
|
|
||
| ## Stack | ||
|
|
||
| - Linting / Code Style | ||
| - [eslint](https://www.npmjs.com/package/eslint) | ||
| - [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier) | ||
| - [ESLint | Next.js](https://nextjs.org/docs/app/building-your-application/configuring/eslint#prettier) | ||
| - [eslint-plugin-check-file](https://www.npmjs.com/package/eslint-plugin-check-file) | ||
| - [Bulletproof React Guide](https://github.com/alan2207/bulletproof-react/blob/master/docs/project-standards.md#file-naming-conventions) | ||
| - [eslint-plugin-n](https://www.npmjs.com/package/eslint-plugin-n) | ||
| - [prettier](https://www.npmjs.com/package/prettier) | ||
| - [@trivago/prettier-plugin-sort-imports](https://www.npmjs.com/package/@trivago/prettier-plugin-sort-imports) | ||
| - [prettier-plugin-tailwindcss](https://www.npmjs.com/package/prettier-plugin-tailwindcss) | ||
| - [Automatic Class Sorting](https://tailwindcss.com/blog/automatic-class-sorting-with-prettier#how-classes-are-sorted) | ||
| - Environment Variables | ||
| - [dotenv](https://www.npmjs.com/package/dotenv) | ||
| - [dotenv-expand](https://www.npmjs.com/package/dotenv-expand) | ||
| - [@t3-oss/env-nextjs](https://www.npmjs.com/package/@t3-oss/env-nextjs) | ||
| - [Documentation](https://env.t3.gg/docs/nextjs) | ||
| - [cross-env](https://www.npmjs.com/package/cross-env) | ||
| - Styles / UI | ||
| - [tailwindcss](https://www.npmjs.com/package/tailwindcss) | ||
| - [@nextui-org/react](https://www.npmjs.com/package/@nextui-org/react) | ||
| - [NextUI](https://nextui.org/docs/guide/introduction) | ||
| - [next-themes](https://www.npmjs.com/package/next-themes) | ||
| - [@tabler/icons-react](https://www.npmjs.com/package/@tabler/icons-react) | ||
| - [Tabler Icon Search](https://tabler.io/icons) | ||
| - Validation | ||
| - [zod](https://www.npmjs.com/package/zod) | ||
| - [@conform-to/zod](https://www.npmjs.com/package/@conform-to/zod) | ||
| - [Conform | Next.js](https://conform.guide/integration/nextjs) | ||
| - [drizzle-zod](https://www.npmjs.com/package/drizzle-zod) | ||
| - [Drizzle Zod Docs](https://orm.drizzle.team/docs/zod) | ||
| - Forms | ||
| - [@conform-to/react](https://www.npmjs.com/package/@conform-to/react) | ||
| - Database | ||
| - [drizzle-orm](https://www.npmjs.com/package/drizzle-orm) | ||
| - [postgres](https://www.npmjs.com/package/postgres) | ||
| - [drizzle-kit](https://www.npmjs.com/package/drizzle-kit) | ||
| - Authentication | ||
| - [next-auth](https://www.npmjs.com/package/next-auth) | ||
| - [@auth/drizzle-adapter](https://www.npmjs.com/package/@auth/drizzle-adapter) | ||
| - [Auth.js Drizzle Adapter Documentation](https://authjs.dev/getting-started/adapters/drizzle) | ||
|
|
||
| ## Branches | ||
|
|
||
| The main branch contains the entire setup. The following branches build on each other from top to bottom: | ||
|
|
||
| - [base](https://github.com/w3cj/next-start/tree/base) | ||
| - eslint / prettier settings | ||
| - [nextui](https://github.com/w3cj/next-start/tree/nextui) | ||
| - layout / styles | ||
| - dark / light theme toggle | ||
| - [typesafe-env](https://github.com/w3cj/next-start/tree/typesafe-env) | ||
| - typesafe environment variables | ||
| - [next-auth](https://github.com/w3cj/next-start/tree/next-auth) | ||
| - google oauth with no database | ||
| - [drizzle](https://github.com/w3cj/next-start/tree/drizzle) / [main](https://github.com/w3cj/next-start) | ||
| - basic drizzle schema with users / accounts / sessions | ||
|
|
||
| ## Setup | ||
|
|
||
| 1. Install dependencies: | ||
|
|
||
| ```sh | ||
| pnpm install | ||
| ``` | ||
|
|
||
| 2. Copy the `.env` file: | ||
|
|
||
| ```sh | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| 3. Update the following values in the `.env` file: | ||
|
|
||
| ```sh | ||
| NEXTAUTH_SECRET=your-value-here | ||
| GOOGLE_CLIENT_ID=your-value-here | ||
| GOOGLE_CLIENT_SECRET=your-value-here | ||
| ``` | ||
|
|
||
| 4. Start the database: | ||
|
|
||
| ```sh | ||
| docker compose up | ||
| ``` | ||
|
|
||
| 5. Migrate the database: | ||
|
|
||
| ```sh | ||
| pnpm run db:migrate | ||
| ``` | ||
|
|
||
| 6. Start the app: | ||
|
|
||
| ```sh | ||
| pnpm run dev | ||
| ``` | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Next.js Discord FAQs](https://nextjs-faq.com/) | ||
| - ["Module not found" error on deployment but build works fine locally](https://nextjs-faq.com/module-not-found-due-to-case-sensitivity) | ||
| - [Bulletproof React](https://github.com/alan2207/bulletproof-react) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.