Skip to content

Commit 32e8adc

Browse files
committed
feat: update README file
meta: development
1 parent 9eb6208 commit 32e8adc

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

+25-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Test Project
1+
# Test Project
22

3-
### Test project for interesting company
3+
### Test project
44

55
---
66
### **Author** - Frontend Developer `Viacheslav Chernogorov`.
@@ -13,8 +13,10 @@
1313
- TypeScript,
1414
- Apolo and Graphql,
1515
- Alias,
16-
- Webpack customization.
17-
16+
- Webpack customization,
17+
- hasky,
18+
- Jest,
19+
- Docs.
1820

1921
---
2022

@@ -34,10 +36,25 @@ After that, in the console, you need to run:
3436

3537
- `npm i` - To install dependencies;
3638

37-
To use:
3839

39-
- `npm start' - The command to start the project;
40-
- `npm run build' - To build the project.
40+
41+
## Scripts
42+
43+
### Available Scripts
44+
45+
In the project directory, you can run:
46+
47+
- `npm start`: Runs the app in development mode.
48+
- `npm run build`: Builds the app for production to the `build` folder.
49+
- `npm test`: Launches the test runner.
50+
- `npm run coverage`: Launches the test runner with coverage reporting.
51+
- `npm run eslint`: Lints the source files using ESLint.
52+
- `npm run eslint-fix`: Lints and fixes the source files using ESLint.
53+
- `npm run docs`: Generates documentation using JSDoc.
54+
55+
---
56+
57+
**Note:** This project uses [react-app-rewired](https://github.com/timarney/react-app-rewired) for customizing Webpack without ejecting from Create React App. It also includes lint-staged, husky, and Jest for linting, pre-commit hooks, and testing respectively.
4158

4259
---
4360

@@ -64,4 +81,4 @@ To use:
6481
1) [Dihitals clock using SCSS/jQuery](https://github.com/ChernoSlava/Digital-Clock.git);
6582
2) [Films review using PUG/SCSS](https://github.com/ChernoSlava/Film-Review );
6683
3) [2d game on Vanila JavaScript/Canvas](https://github.com/ChernoSlava/Fluppy );
67-
4) [React/Next js burger website](https://github.com/ChernoSlava/Burgers-Next-JS ).
84+
4) [React/Next js burger website](https://github.com/ChernoSlava/Burgers-Next-JS ).

0 commit comments

Comments
 (0)