Boilerplate and Starter for Next JS 12+, Prisma ORM, Next-Auth and TypeScript.

Fullstack project structure

🚀 Boilerplate and Starter for Next.js, SASS, Prisma ORM, Next-Auth and TypeScript ⚡️ Made with developer experience first: Next.js, TypeScript, ESLint, Prettier, Husky, Lint-Staged.

Features

Developer experience first:

🔥 Next.js 12
🦄 Integrate with next-auth
🦄 Integrate with prisma
🎨 Integrate with sass
🎉 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
🤖 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)
💯 Maximize lighthouse score
🤖 i18n Locatization next-translate
🦄 Integrate with cypress

Built-in feature from Next.js:

☕ Minify HTML & CSS
💨 Live reload
✅ Cache busting

Philosophy

Minimal code
SEO-friendly
🚀 Production-ready
🚀 Serverless-ready

Requirements

Node.js, yarn and npm

Getting started

Run the following command on your local environment:

git clone --depth=1 https://github.com/bbg/nextjs-boilerplate.git my-project-name
cd my-project-name
yarn install

Then, you can run locally in development mode with live reload:

yarn run dev

Open http://localhost:3000 with your favorite browser to see your project.

├── README.md                # README file
├── cypress                  # Cypress root folder
├── docs                     # Project document folder
├── public                   # Public folder
├── locales                  # Localization Json files are kept in this folder
├── src
│   ├── components           # All Components
│   ├── hooks                # React hooks
│   ├── pages                # Next JS pages
│   ├── scss                 # SCSS styles folder
│   └── functions            # All functions are collected here.
|   └── types                # Global types folder.
├── db.prisma                # Prisma database schema
├── tsconfig.json            # TypeScript configuration
├── i18n.json                # Next-Translation configuration
├── cypress.json             # Cypress configuration
├── next.config.js           # Next JS configuration
├── netlify.toml             # Netlify publish configuration

Deploy to production

You can see the results locally in production mode with:

$ yarn run build
$ yarn run start

The generated HTML and CSS files are minified (built-in feature from Next js).

You can create an optimized production build with:

yarn 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.

Commands Scripts

├── dev                # NextJS Development Run
├── build              # NextJS Build
├── build:stats        # NextJS Bundle Analyze
├── build:types        # Types check and build
├── start              # NextJS Production Start
├── export             # NextJS Static Export
├── clean              # .next and out file cleaner
├── lint               # Eslint Check
├── lint:fix           # Eslint Check and Fix
├── forrmat            # Prettier Run
├── prepare            # Huksy Install
├── cy:open            # Cypress Browser E2E Testing Run
├── cy:run             # Cypress Headlesss E2E Testing Run
├── prisma:gen         # Prisma Generator
├── prisma:push        # Prisma DB Schema Push
├── prisma:studio      # Prisma Studio DB Client Open

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:

Preview

Preview the example live on StackBlitz:

Contributions

Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug.

License

See LICENSE for more information.

olcaneristi / nextjs-boilerplate