This is a readme from next.js 12 boilerplate.
Boilerplate to help developers to have a fast project configuration using the most recent next version and some tools to improve the developer experience.
Check our π example
- π₯ Next.js for Static Site Generator
- π¨ Integrate with Tailwind CSS
- π Type checking TypeScript
- β Strict Mode for TypeScript and React 17
- βοΈ Linter with ESLint (default NextJS, NextJS Core Web Vitals and Airbnb configuration)
- π Code Formatter with Prettier
- π¦ Husky for Git Hooks
- π« Lint-staged for running linters on Git staged files
- π VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript
- π€ SEO metadata, JSON-LD and Open Graph tags with Next SEO
- βοΈ Bundler Analyzer
- π Include a FREE minimalist theme
- π― Maximize lighthouse score
- π₯ SWC instead of babel
- π PlopJS and Axios
.
βββ README.md # README file
βββ next.config.js # Next JS configuration
βββ docs # documentation mdx
βββ e2e # Cypress e2e
βββ public # Public folder
β βββ assets
β βββ images # Image used by default template
βββ
β βββ layout # Atomic layout components
β βββ models # TypeScript models
β βββ constants # Constants
β βββ pages # Next JS pages
β βββ styles # PostCSS style folder with Tailwind
β βββ i18n # Locale i18n
β βββ utils # Utility folder
βββ tailwind.config.js # Tailwind CSS configuration
βββ tsconfig.json # TypeScript configuration
- Clone you project to your machine
yarn
yarn generate
After this, select if you want to create a page or component and set the name.
You can change the templates and settings of generator at path generators
on project root.