{"id":22598905,"url":"https://github.com/antoinemcx/react-nextjs-boilerplate","last_synced_at":"2025-04-11T01:21:42.748Z","repository":{"id":186356917,"uuid":"675036608","full_name":"antoinemcx/React-Nextjs-Boilerplate","owner":"antoinemcx","description":"🚀 Next.js 14+ full-stack Starter made with TypeScript and Tailwind CSS (authentication, modern theme, database migrations and more)","archived":false,"fork":false,"pushed_at":"2023-11-19T17:37:57.000Z","size":581,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T05:59:37.555Z","etag":null,"topics":["boilerplate","eslint","next-auth","next-sitemap","next-theme","nextjs","prisma","react","starter","tailwindcss","typescript"],"latest_commit_sha":null,"homepage":"https://discord.gg/G6WQsMQShZ","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/antoinemcx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-05T15:08:07.000Z","updated_at":"2024-05-29T08:10:42.000Z","dependencies_parsed_at":"2023-11-19T18:27:56.009Z","dependency_job_id":"6d8c3cda-6ff7-4871-a865-9112a9af6e66","html_url":"https://github.com/antoinemcx/React-Nextjs-Boilerplate","commit_stats":null,"previous_names":["antoinemcx/react-nextjs-boilerplate"],"tags_count":3,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoinemcx%2FReact-Nextjs-Boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoinemcx%2FReact-Nextjs-Boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoinemcx%2FReact-Nextjs-Boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoinemcx%2FReact-Nextjs-Boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/antoinemcx","download_url":"https://codeload.github.com/antoinemcx/React-Nextjs-Boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248323384,"owners_count":21084491,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","eslint","next-auth","next-sitemap","next-theme","nextjs","prisma","react","starter","tailwindcss","typescript"],"created_at":"2024-12-08T11:07:22.791Z","updated_at":"2025-04-11T01:21:42.729Z","avatar_url":"https://github.com/antoinemcx.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e🚀 React-Nextjs-Boilerplate\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n    Starter \u003ca href=\"https://nextjs.org/\"\u003eNext.js\u003c/a\u003e (14+) template for your React projects.\u003cbr /\u003e\n    If you like the project, feel free to put a ⭐ ! If you need help, join the \u003ca href=\"https://discord.gg/G6WQsMQShZ\"\u003eserver support\u003c/a\u003e.\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca title=\"MIT License\" href=\"LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-blue\" alt=\"MIT License\"\u003e\u003c/a\u003e\n    \u003ca title=\"CodeFactor\" href=\"https://www.codefactor.io/repository/github/antoinemcx/react-nextjs-boilerplate\"\u003e\n        \u003cimg src=\"https://www.codefactor.io/repository/github/antoinemcx/react-nextjs-boilerplate/badge\" alt=\"CodeFactor\"\u003e\n    \u003c/a\u003e\n    \u003ca title=\"Stars\" href=\"[LICENCE](https://github.com/antoinemcx/react-nextjs-boilerplate)\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/stars/antoinemcx/react-nextjs-boilerplate\" alt=\"Stars\"\u003e\n    \u003c/a\u003e\n    \u003ca title=\"Support server\" href=\"https://discord.gg/G6WQsMQShZ\"\u003e\n        \u003cimg src=\"https://img.shields.io/discord/738122381062832180.svg?\u0026logo=discord\u0026logoColor=ffffff\u0026color=7389D8\u0026labelColor=6A7EC2\u0026label=Support\" alt=\"Support server\"\u003e\n    \u003c/a\u003e\n\n   \u003cbr\u003e\n\u003c/p\u003e\n\n## 📚 Features\n\nWhat's first :\n\n-   🚀 Production-ready with a starter file structure !\n-   🌈 Modern theme using shadcn/ui and with global css variables\n    -   ✏️ Responsive navbar\n    -   💄 Custom UI components (dropdown menus, buttons, headings, toast notifications, ...)\n    -   ⏳ Loading page and states for buttons\n-   🌙 Dark/Light/System mode (thanks to [next-themes](https://www.npmjs.com/package/next-themes))\n-   👮 Private routing\n-   🔐 Beautiful sign up and sign (with credentials or google account) in pages\n-   ❌ Custom error pages (404 and others)\n-   📡 MySQL (or other) database integration\n\nFor a better developer experience :\n\n-   🔥 Full-stack application with [Next.js](https://nextjs.org/) (minify, live reload, etc.)\n-   ⚡ [TypeScript](https://www.typescriptlang.org/) for type checking\n-   💯 **95+** lighthouse score\n-   🎨 Integrate with [Tailwind CSS](https://tailwindcss.com/) (processed by [PostCSS](https://postcss.org/))\n-   ✏️ Linter with [ESLint](https://eslint.org/) and code formatter with [Prettier](https://prettier.io/) (default configs)\n-   💡 Absolute Imports using `@` prefix\n-   🔑 Authentication system using [Prisma](https://www.prisma.io/) and [next-auth](https://github.com/nextauthjs/next-auth)\n-   🗂 VSCode settings configuration\n-   🗺️ Sitemap.xml files and robots.txt with [next-sitemap](https://www.npmjs.com/package/next-sitemap)\n\n\u003cbr\u003e\n\n## 📸 Screenshots\n\n_Click on each arrow to see the screenshots :_\n\n\u003cdetails\u003e\n    \u003csummary\u003eHome page (dark)\u003c/summary\u003e\n    \u003cimg src=\"docs/images/home-page.png\" alt=\"Home Page (dark)\"\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003eHome page (light)\u003c/summary\u003e\n    \u003cimg src=\"docs/images/home-page-lightMode.png\" alt=\"Home page (light)\"\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003eHome page (mobile)\u003c/summary\u003e\n    \u003cimg src=\"docs/images/home-page-mobile.png\" alt=\"Home page (mobile)\"\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003eError page\u003c/summary\u003e\n    \u003cimg src=\"docs/images/error-page.png\" alt=\"Error Page\"\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003eLogin page\u003c/summary\u003e\n    \u003cimg src=\"docs/images/login-page.png\" alt=\"Login Page\"\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003eRegister page\u003c/summary\u003e\n    \u003cimg src=\"docs/images/register-page.png\" alt=\"Register Page\"\u003e\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## 🚀 Getting Started\n\n### 1. Clone the repository\n\n```bash\ngit clone --depth=1 https://github.com/antoinemcx/React-Nextjs-Boilerplate.git \u003cYOUR_PROJECT_NAME\u003e\ncd \u003cYOUR_PROJECT_NAME\u003e\n```\n\n### 2. Installation\n\nInstall the dependencies :\n\n```bash\nnpm install\n# or\nyarn install\n# or\npnpm install\n```\n\n### 3. Database Setup\n\nThis template uses a database for the authentication of next-auth.  \nCreate the MySQL/MariaDB database and insert the database URL in the **.env** file.\u003cbr\u003e\n\n![](https://i.imgur.com/ALeKvsf.png 'Creating a database on phpMyAdmin')\n\nAfter creating the database, run following command :\n\n```bash\nnpx prisma migrate deploy\n# or\nyarn prisma migrate deploy\n# or\npnpx prisma migrate deploy\n```\n\n### 4. Configuration\n\nRename the **.env.example** file in the root directory into **.env**.  \nFor more information on what to put in the file, please refer to the [configuration guide](/docs/CONFIGURATION.md).\n\n### 5. Run the development server:\n\n```bash\nnpm run dev\n# or\nyarn dev\n# or\npnpm dev\n```\n\nNow open [http://localhost:3000](http://localhost:3000) with your favorite browser to see the application.\n\n### 6. You liked it ? Star it :\n\n**Optional** : Add a ⭐ to the repository, it helps a lot. Thanks !\n\n\u003cbr\u003e\n\n## 📄 Documentation\n\n-   [Configuration](/docs/CONFIGURATION.md) : Guide for getting the values for the **.env** file\n-   [Cleaning](/docs/CLEANING.md) : Files to remove to be ready to code\n-   [Prisma migrations](/docs/prisma_migrations.md) : How to create and manage migration files for your database using Prisma\n\n## 🛠 Scripts\n\nIn development, you will mainly use `yarn dev` ; however, here are all the scripts available :\n\n| `yarn \u003cscript\u003e`, `npm run \u003cscript\u003e` or `pnpm \u003cscript\u003e` | Description                                                                                              |\n| ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |\n| `dev`                                                  | Launch your app on localhost:300                                                                         |\n| `build`                                                | Builds the application for production and regenerate the sitemap                                         |\n| `start`                                                | Serves your app for production or preview                                                                |\n| `lint`                                                 | [Lints](https://en.wikipedia.org/wiki/Lint_%28software%29) the project to review errors before launching |\n\n\u003cbr\u003e\n\n## 💭 More information\n\nFor any errors found, please contact me [here](https://discord.gg/G6WQsMQShZ) or do a pull request.  \nThis repository is licensed under the MIT License. See the `LICENSE` file ([here](LICENSE)) for more information.\n\n### Made with ❤️ by [antoinemcx](https://github.com/antoinemcx) in TypeScript.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoinemcx%2Freact-nextjs-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantoinemcx%2Freact-nextjs-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoinemcx%2Freact-nextjs-boilerplate/lists"}