summaryrefslogtreecommitdiffstats
path: root/README.md
blob: db36a463393c430d88448763c86b97ebdedd6ee5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Next.js TypeScript Template

> A template for quickly starting a Next.js-based project.

## Features

1. TypeScript-enabled. Check out the [TypeScript](./tsconfig.json)
   configuration
2. ESLint-enabled
3. a grid-based Default Layout
4. Switch between dark and light themes
5. Loader

## ESLint Rules

- Style Guide: `airbnb-typescript`
- `no-use-before-define`: `off`,
- `@typescript-eslint/no-use-before-define`: `[error]`,
- `react/jsx-filename-extension`: `[1, { extensions: [".tsx"] }]`,
- `import/no-default-export`: `[2]`,
- `import/prefer-default-export`: `off`,
- `react/jsx-props-no-spreading`: `off`,
- `react/destructuring-assignment`: `[1, never]`

## Helper Scripts

- to generate a new component, run `yarn gc component-name`