Skip to content
This repository was archived by the owner on Oct 15, 2021. It is now read-only.

Commit 5677d08

Browse files
committed
Updated Readme
1 parent 3af835d commit 5677d08

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
- [Next.js TypeScript Material UI quality checking project](#nextjs-typescript-material-ui-quality-checking-project)
2+
- [Deploy your own](#deploy-your-own)
3+
- [How to use](#how-to-use)
4+
- [Scripts](#scripts)
5+
- [build](#build)
6+
- [dev](#dev)
7+
- [format](#format)
8+
- [lint](#lint)
9+
- [start](#start)
10+
- [test](#test)
11+
- [type-check](#type-check)
12+
- [quality](#quality)
13+
114
# Next.js TypeScript Material UI quality checking project
215

316
Includes TypeScript, Material UI, ESLint, Jest, and React Testing Library
@@ -27,6 +40,9 @@ All scripts can be run by prefixing with `npm run`, for example `npm run build`
2740
### build
2841

2942
Builds the production application in the .next folder.
43+
```bash
44+
npm run build
45+
```
3046

3147
### dev
3248

@@ -41,11 +57,18 @@ npm run dev -p 4000
4157
### format
4258

4359
Runs ESLint and Prettier auto-formatting.
60+
```bash
61+
npm run format
62+
```
4463

4564
### lint
4665

4766
Runs ESLint static code analysis based on your `.eslintrc` configuration
4867

68+
```bash
69+
npm run lint
70+
```
71+
4972
### start
5073

5174
Starts the application in production mode. The application should be compiled with `npm run build` first.
@@ -60,10 +83,22 @@ npm run start -p 4000
6083

6184
Runs Jest unit tests to validate changes between commits
6285

86+
```bash
87+
npm run test
88+
```
89+
6390
### type-check
6491

6592
Runs TypeScript compiler to validate there are no type errors between commits
6693

94+
```bash
95+
npm run type-check
96+
```
97+
6798
### quality
6899

69100
Runs `type-check`, `lint`, and `test` to make an better developer experience catching preventable quality errors.
101+
102+
```bash
103+
npm run **quality**
104+
```

0 commit comments

Comments
 (0)