This is a Next.js boilerplate

What is inside?

This project uses lot of stuff as:

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

Getting Started

First, install dependencies:

npm install
# or
yarn install

Second, 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.tsx. 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
• 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
• generate: create folder with files for a component

Folder Architecture

• __ tests __

  Folder responsible for the storage of project tests

• .github

  Folder responsible for the storage of dependabot settings

• .husky

  Folder responsible for the storage of husky settings

• .jest

  Folder responsible for the storage of tests settings

• .storybook

  Folder responsible for the storage of storybook settings

• generators

  Folder responsible for the storage of plop file templates

• public

  Folder responsible for the storage of public files

• src

  • assets

    Folder responsible for the storage of images, svg's and fonts

  • components

    Folder responsible for the storage of components

  • contexts

    Folder responsible for the storage of contexts

  • hooks

    Folder responsible for the storage of hooks

  • pages

    Folder responsible for the storage of pages

  • services

    Folder responsible for the storage of services integration and requests

  • styles

    Folder responsible for the storage of global styles

  • themes

    Folder responsible for the storage of theme settings

  • utils

    Folder responsible for the storage of utility functions

• stories

  Folder responsible for the storage of storie in storybook

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.