Clone this project and use it to create your own Next.js project. You can check a Next js templates demo.
Features
Developer experience first:
π₯ Next.js for Static Site Generatorπ¨ Integrate with Tailwind CSSπ PostCSS for processing Tailwind CSS and integrated tostyled-jsx
π Type checking TypeScriptβ Strict Mode for TypeScript and React 17βοΈ Linter with ESLint (default NextJS, NextJS Core Web Vitals, Tailwind CSS and Airbnb configuration)π‘ Absolute Importsπ 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π±οΈ 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
- Minimal code
- SEO-friendly
π Production-ready
Nextless.js SaaS Boilerplate
Build your SaaS product faster with React SaaS Boilerplate.
Premium Themes
Green Nextjs Landing Page Template | Purple Saas Nextjs Theme |
---|---|
Find more Nextjs Themes.
Requirements
- Node.js 14+ and npm
Getting started
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
βββ next.config.js # Next JS configuration
βββ public # Public folder
β βββ assets
β βββ images # Image used by default template
βββ src
β βββ layout # Atomic layout components
β βββ pages # Next JS pages
β βββ styles # PostCSS style folder with Tailwind
β βββ templates # Default template
β βββ utils # Utility folder
βββ tailwind.config.js # Tailwind CSS configuration
βββ tsconfig.json # TypeScript configuration
Customization
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
Deploy to production
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.
Deploy to Netlify
Clone this repository on own GitHub account and deploy to Netlify:
Deploy to Vercel
Deploy this Next JS Boilerplate on Vercel in one click:
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.
Pro tips: if you need a project wide type checking with TypeScript, you can run a build with Cmd + Shift + B 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.
License
Licensed under the MIT License, Copyright Β© 2022
See LICENSE for more information.
Made with