-
Notifications
You must be signed in to change notification settings - Fork 0
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
1 parent
89521ad
commit 1246020
Showing
1 changed file
with
0 additions
and
187 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 |
|---|---|---|
| @@ -1,188 +1 @@ | ||
| # Boilerplate and Starter for Next JS 13+, Tailwind CSS 3.3 and TypeScript [](https://twitter.com/ixartz) | ||
|
|
||
| <p align="center"> | ||
| <a href="https://creativedesignsguru.com/demo/Nextjs-Boilerplate/"><img src="public/assets/images/nextjs-starter-banner.png?raw=true" alt="Next js starter banner"></a> | ||
| </p> | ||
|
|
||
| 🚀 Boilerplate and Starter for Next.js, Tailwind CSS and TypeScript ⚡️ Made with developer experience first: Next.js, TypeScript, ESLint, Prettier, Husky, Lint-Staged, Jest, Testing Library, Commitlint, VSCode, Netlify, PostCSS, Tailwind CSS. | ||
|
|
||
| Clone this project and use it to create your own [Next.js](https://nextjs.org) project. You can check a [Next js templates demo](https://creativedesignsguru.com/demo/Nextjs-Boilerplate/). | ||
|
|
||
| ### Features | ||
|
|
||
| Developer experience first: | ||
|
|
||
| - ⚡ [Next.js](https://nextjs.org) for Static Site Generator | ||
| - 🔥 Type checking [TypeScript](https://www.typescriptlang.org) | ||
| - 💎 Integrate with [Tailwind CSS](https://tailwindcss.com) | ||
| - ✅ Strict Mode for TypeScript and React 18 | ||
| - 📏 Linter with [ESLint](https://eslint.org) (default NextJS, NextJS Core Web Vitals, Tailwind CSS and Airbnb configuration) | ||
| - 💖 Code Formatter with [Prettier](https://prettier.io) | ||
| - 🦊 Husky for Git Hooks | ||
| - 🚫 Lint-staged for running linters on Git staged files | ||
| - 🚓 Lint git commit with Commitlint | ||
| - 📓 Write standard compliant commit messages with Commitizen | ||
| - 🦺 Unit Testing with Jest and React Testing Library | ||
| - 🧪 E2E Testing with Cypress | ||
| - 👷 Run tests on pull request with GitHub Actions | ||
| - 🎉 Storybook for UI development | ||
| - 🎁 Automatic changelog generation with Semantic Release | ||
| - 🔍 Visual testing with Percy (Optional) | ||
| - 💡 Absolute Imports using `@` prefix | ||
| - 🗂 VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript, Jest | ||
| - 🤖 SEO metadata, JSON-LD and Open Graph tags with Next SEO | ||
| - 🗺️ Sitemap.xml and robots.txt with next-sitemap | ||
| - ⚙️ [Bundler Analyzer](https://www.npmjs.com/package/@next/bundle-analyzer) | ||
| - 🖱️ One click deployment with Vercel or Netlify (or manual deployment to any hosting services) | ||
| - 🌈 Include a FREE minimalist theme | ||
| - 💯 Maximize lighthouse score | ||
|
|
||
| Built-in feature from Next.js: | ||
|
|
||
| - ☕ Minify HTML & CSS | ||
| - 💨 Live reload | ||
| - ✅ Cache busting | ||
|
|
||
| ### Philosophy | ||
|
|
||
| - All the Next.js pages are statically generated by default. You can easily switch to SSR adding `getServerSideProps` to your page. | ||
| - Nothing is hidden from you, so you have the freedom to make the necessary adjustments to fit your needs and preferences. | ||
| - Minimal code | ||
| - SEO-friendly | ||
| - 🚀 Production-ready | ||
|
|
||
| ### Nextless.js SaaS Boilerplate | ||
|
|
||
| Build your SaaS product faster with [React SaaS Boilerplate](https://nextlessjs.com). | ||
|
|
||
| [](https://nextlessjs.com) | ||
|
|
||
| ### Premium Themes | ||
|
|
||
| | [Green Nextjs Landing Page Template](https://creativedesignsguru.com/landing-green-modern-nextjs-theme/) | [Purple Saas Nextjs Theme](https://creativedesignsguru.com/landing-purple-modern-react-theme/) | | ||
| | --- | --- | | ||
| | [](https://creativedesignsguru.com/landing-green-modern-nextjs-theme/) | [](https://creativedesignsguru.com/landing-blue-modern-react-theme/) | | ||
|
|
||
| Find more [Nextjs Themes](https://creativedesignsguru.com/category/nextjs/). | ||
|
|
||
| ### Requirements | ||
|
|
||
| - Node.js 14+ and npm | ||
|
|
||
| ### Getting started | ||
|
|
||
| Run the following command on your local environment: | ||
|
|
||
| ```shell | ||
| git clone --depth=1 https://github.com/ixartz/Next-js-Boilerplate.git my-project-name | ||
| cd my-project-name | ||
| npm install | ||
| ``` | ||
|
|
||
| Then, you can run locally in development mode with live reload: | ||
|
|
||
| ```shell | ||
| npm run dev | ||
| ``` | ||
|
|
||
| Open http://localhost:3000 with your favorite browser to see your project. | ||
|
|
||
| ```shell | ||
| . | ||
| ├── README.md # README file | ||
| ├── __mocks__ # Mocks for testing | ||
| ├── .github # GitHub folder | ||
| ├── .husky # Husky configuration | ||
| ├── .vscode # VSCode configuration | ||
| ├── public # Public assets folder | ||
| ├── src | ||
| │ ├── layouts # Layouts components | ||
| │ ├── pages # Next JS Pages | ||
| │ ├── pages.test # Next JS Pages tests (this avoids tests to be treated as a Next.js pages) | ||
| │ ├── styles # Styles folder | ||
| │ ├── templates # Default template | ||
| │ └── utils # Utility functions | ||
| ├── tailwind.config.js # Tailwind CSS configuration | ||
| └── tsconfig.json # TypeScript configuration | ||
| ``` | ||
|
|
||
| ### Customization | ||
|
|
||
| You can easily configure Next js Boilerplate by making a search in the whole project with `FIXME:` for making quick customization. Here is some of the most important files to customize: | ||
|
|
||
| - `public/apple-touch-icon.png`, `public/favicon.ico`, `public/favicon-16x16.png` and `public/favicon-32x32.png`: your website favicon, you can generate from https://favicon.io/favicon-converter/ | ||
| - `src/styles/global.css`: your CSS file using Tailwind CSS | ||
| - `src/utils/AppConfig.ts`: configuration file | ||
| - `src/templates/Main.tsx`: default theme | ||
| - `next-sitemap.config.js`: sitemap configuration | ||
|
|
||
| You have access to the whole code source if you need further customization. The provided code is only example for you to start your project. The sky is the limit 🚀. | ||
|
|
||
| ### Commit Message Format | ||
|
|
||
| The project enforces [Conventional Commits](https://www.conventionalcommits.org/) specification. This means that all your commit messages must be formatted according to the specification. To help you write commit messages, the project uses [Commitizen](https://github.com/commitizen/cz-cli), an interactive CLI that guides you through the commit process. To use it, run the following command: | ||
|
|
||
| ```shell | ||
| npm run commit | ||
| ``` | ||
|
|
||
| One of the benefits of using Conventional Commits is that it allows us to automatically generate a `CHANGELOG` file. It also allows us to automatically determine the next version number based on the types of commits that are included in a release. | ||
|
|
||
| ### Deploy to production | ||
|
|
||
| You can see the results locally in production mode with: | ||
|
|
||
| ```shell | ||
| $ npm run build | ||
| $ npm run start | ||
| ``` | ||
|
|
||
| The generated HTML and CSS files are minified (built-in feature from Next js). It will also remove unused CSS from [Tailwind CSS](https://tailwindcss.com). | ||
|
|
||
| You can create an optimized production build with: | ||
|
|
||
| ```shell | ||
| npm run build-prod | ||
| ``` | ||
|
|
||
| Now, your blog is ready to be deployed. All generated files are located at `out` folder, which you can deploy with any hosting service. | ||
|
|
||
| ### Testing | ||
|
|
||
| All tests are colocated with the source code inside the same directory. So, it makes it easier to find them. Unfortunately, it is not possible with the `pages` folder which is used by Next.js for routing. So, what is why we have a `pages.test` folder to write tests from files located in `pages` folder. | ||
|
|
||
| ### Deploy to Netlify | ||
|
|
||
| Clone this repository on own GitHub account and deploy to Netlify: | ||
|
|
||
| [](https://app.netlify.com/start/deploy?repository=https://github.com/ixartz/Next-js-Boilerplate) | ||
|
|
||
| ### Deploy to Vercel | ||
|
|
||
| Deploy this Next JS Boilerplate on Vercel in one click: | ||
|
|
||
| [](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fixartz%2FNext-js-Boilerplate) | ||
|
|
||
| ### VSCode information (optional) | ||
|
|
||
| If you are VSCode users, you can have a better integration with VSCode by installing the suggested extension in `.vscode/extension.json`. The starter code comes up with Settings for a seamless integration with VSCode. The Debug configuration is also provided for frontend and backend debugging experience. | ||
|
|
||
| With the plugins installed on your VSCode, ESLint and Prettier can automatically fix the code and show you the errors. Same goes for testing, you can install VSCode Jest extension to automatically run your tests and it also show the code coverage in context. | ||
|
|
||
| Pro tips: if you need a project wide type checking with TypeScript, you can run a build with <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd> on Mac. | ||
|
|
||
| ### Contributions | ||
|
|
||
| Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug. Totally open to any suggestions and improvements. | ||
|
|
||
| ### License | ||
|
|
||
| Licensed under the MIT License, Copyright © 2022 | ||
|
|
||
| See [LICENSE](LICENSE) for more information. | ||
|
|
||
| --- | ||
|
|
||
| Made with ♥ by [CreativeDesignsGuru](https://creativedesignsguru.com) [](https://twitter.com/ixartz) | ||
|
|
||
| [](https://nextlessjs.com) |