4KQA Boilerplate

Directory structure

public/                   # Static files, served from the server root and should contain files that likely are not changed
src/
  ├── assets/             # Uncompiled Assets files, such as fonts, images, icons,..., inline contents
  ├── components/         # Most atomic components, e.g. Button, Table,... These components should only render data and not handle logic.
  ├── hooks/              # Custom hooks. Always prepend them with `use` to follow the rules of hooks.
  ├── features/           # When using a headless C.M.S to build page modules (Drag and Drop page builder), create these page modules inside here.
  ├── pages/              # Next.js "pages"
  ├── partials/           # Layout directory. Place here your Header, Footer, Layout components
  ├── theme/              # ChakraUI custom theming
  ├── types/              # Typescript Types
  └──views/               # Next.js "pages" specific components that should not receive a route path.

Next.js Boilerplate Description

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

Storybook

npm run storybook

You will be redirected to the page when compiling is done.

Next

First, run the development server:

npm run 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.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

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.