๐ 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 project. You can check a Next js templates demo.
Developer experience first:
- โก Next.js for Static Site Generator
- ๐ฅ Type checking TypeScript
- ๐ Integrate with Tailwind CSS
- โ Strict Mode for TypeScript and React 18
- ๐ Linter with ESLint (default NextJS, NextJS Core Web Vitals, Tailwind CSS and Airbnb configuration)
- ๐ Code Formatter with Prettier
- ๐ฆ Husky for Git Hooks
- ๐ซ Lint-staged for running linters on Git staged files
- ๐ Lint git commit with Commitlint
- ๐ฆบ Testing with Jest and React Testing Library
- ๐ก 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
- โ๏ธ Bundler 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
- Minimal code
- SEO-friendly
- ๐ Production-ready
Build your SaaS product faster with React SaaS Boilerplate.
Green Nextjs Landing Page Template | Purple Saas Nextjs Theme |
---|---|
Find more Nextjs Themes.
- Node.js 14+ and npm
Run the following command on your local environment:
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:
npm run dev
Open http://localhost:3000 with your favorite browser to see your project.
.
โโโ 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 avoid test to 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
You can easily configure Next js Boilerplate. Please change the following file:
public/apple-touch-icon.png
,public/favicon.ico
,public/favicon-16x16.png
andpublic/favicon-32x32.png
: your website favicon, you can generate from https://favicon.io/favicon-converter/src/styles/global.css
: your CSS file using Tailwind CSSsrc/utils/AppConfig.ts
: configuration filesrc/templates/Main.tsx
: default theme
You can see the results locally in production mode with:
$ npm run build
$ npm run start
The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from Tailwind CSS.
You can create an optimized production build with:
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.
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.
Clone this repository on own GitHub account and deploy to Netlify:
Deploy this Next JS Boilerplate on Vercel in one click:
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 Cmd + Shift + B on Mac.
Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug.
Licensed under the MIT License, Copyright ยฉ 2022
See LICENSE for more information.
Made with โฅ by CreativeDesignsGuru
Here is acceptable commit types:
[build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test]