Skip to content

A NextJS project boilerplate ready for development, lint and tests.

Notifications You must be signed in to change notification settings

cardososamantha/boilerplate

Repository files navigation

This is a Next.js boilerplate bootstrapped with create-next-app.

What's the boilerplate uses?

  • Typescript

  • NextJS

  • styled-components

  • Jest

  • React Testing Library

  • Eslint

  • Prettier

  • Husky

  • Githooks

  • Storybook

Getting started

  • Clone this repository and open it in the source code in your IDE/code editor.

  • Run yarn or npm to install all dependencies.

Commands

  • dev: runs your application on localhost:3000

  • build: creates the production build version

  • start: starts a simple server with the build production code

  • 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

  • storybook: runs storybook on localhost:6006

  • build-storybook: create the build version of storybook

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.