Next.js starter

Kick off your project with this boilerplate.

🚀 Quick Start

git clone
cd
yarn install
yarn run dev

your site is now running at http://localhost:3000

📁 Folder Structure

A quick look at the directories you'll see in this project.

Root driectory layout

.
├── pages               #
├── public              #
├── styles              #
├── api                 #
├── components          #
├── context             # (alternatively `store`)
├── hooks               # Custom hooks
├── utils               #
├── libs                #
├── cypress             # Automated tests
├── README.md           #
└── ...

Pages

Each page is associated with a route based on its file name.

.
├── ...
├── pages               #
│   ├── api             # API endpoint
│   ├── _app.tsx        # App component to initialize pages
│   ├── _document.tsx   # Custom document to augment application's <html> and <body> tags
│   └── ...
└── ...

Public

Next.js can serve static files, like images, under a folder called public in the root directory.

.
├── ...
├── public              #
│   ├── favicons        #
│   └── ...
└── ...

Styles

Css, theme configuration files are placed into this folder.

.
├── ...
├── styles              #
│   ├── theme.tsx       #
│   └── ...
└── ...

Api

Api call related functions.

Components

Components are independent and reusable bits of code.

.
├── ...
├── components          #
│ ├── icons             #
│ ├── atoms             #
│ ├── molecules         #
│ ├── organisms         #
│ └── templates         #
└── ...

Context

Context provides a way to pass data through the component tree without having to pass props down manually at every level. (just like redux)

.
├── ...
├── context             #
│   ├── auth            #
│   └── ...
└── ...

Hooks

Custom hook allows you to extract some components logic into a reusable function that starts with use and that call can other hooks.

.
├── ...
├── hooks                #
│   ├── useScript.tsx    #
│   └── ...
└── ...

Utils

Small snippets you can use throughout the application. Short and specific functions and constants used throughout application.

Libs

Libraries you can use throughout the application. A library is a JavaScript file that contains a bunch of functions, and those functions accomplish some specific purpose.

.
├── ...
├── libs                  #
│   ├── gtm.ts            #
│   └── ...
└── ...

Cypress

Automated tests with cypress.

.
├── ...
├── cypess                #
│ ├── fixtures            # Fixed data sets
│ ├── integration         # End-to-end, integration tests (alternatively `e2e`)
│ ├── plugins             #
│ ├── support             #
└── ...

📛 Naming

👨‍🦳 React Component

Extensions: Use .tsx extension for React components.
Filename: Use PascalCase for filenames. E.g., ReservationCard.tsx.

Reference Naming: Use PascalCase for React components and camelCase for their instances.

// bad
import reservationCard from './ReservationCard';

// good
import ReservationCard from './ReservationCard';

// bad
const ReservationItem = <ReservationCard />;

// good
const reservationItem = <ReservationCard />;

Component Naming: Use the filename as the component name. For example, ReservationCard.tsx should have a reference name of ReservationCard. However, for root components of a directory, use index.tsx as the filename and use the directory name as the component name:
```
// bad
import Footer from './Footer/Footer';

// bad
import Footer from './Footer/index';

// good
import Footer from './Footer';
```

🐪 Others

Always use camelCase for others.

scripts
folders
variables
functions

⭐️ Stack

Framework: Next.js
State Management: React Query, Context API
Styling: Chakra-ui, Emotion
Forms: React Hook Form
Testing: Cypress

hokyunrhee/next.js-starter