This is a Next.js boilerplate to be create a NextJS project with React

What is inside?

This project uses lot of stuff as:

• TypeScript
• NextJS
• Styled Components
• Jest
• React Testing Library
• Storybook
• Eslint
• Prettier
• Husky
• Plop

How to use

Create project with boilerplate example

npx create-next-app -e https://github.com/johnywalves/next-pages-boilerplate
# or
yarn create next-app -e https://github.com/johnywalves/next-pages-boilerplate

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Commands

• dev: runs your application on localhost:3000
• build: creates the production build version
• start: starts a simple server with the build production code
• storybook: runs storybook on localhost:6006
• build-storybook: create the build version of storybook
• next:lint: runs the linter in all components and pages from NextJS
• lint: runs the linter in all components and pages
• test: runs jest to test all components and pages
• test:watch: runs jest in watch mode
• generate: create a component using a template

Generate Static Files

The deploy script has been removed to perform the export configuration is required, as described in the Next.js document

/**
 * @type {import('next').NextConfig}
 */
const nextConfig = {
  output: 'export',
  // Optional: Add a trailing slash to all paths `/about` -> `/about/`
  // trailingSlash: true,
  // Optional: Change the output directory `out` -> `dist`
  // distDir: 'dist',
}

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.