Skip to content

Commit c279652

Browse files
Update README.md
1 parent ebb63b9 commit c279652

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,12 @@ after that auto launch todo app on your default browser and code edit ready.
7070
- [Github Actions](https://github.com/features/actions): Automation run tests, lint, typecheck, build
7171
- [Depfu](https://depfu.com/github/ryota-murakami/react-typescript-todomvc-2022?project_id=9618): Keep latest npm packages automaticaly
7272

73-
## 👩‍💻 Usage
73+
## Command
74+
75+
You can do exact same command with npm, or [install yarn](https://classic.yarnpkg.com/en/docs/install#mac-stable) easily if you have interest.
76+
77+
### `yarn` or `yarn install`
78+
Install all Node Package Modules that depending this project.
7479

7580
### `yarn start`
7681

@@ -82,6 +87,9 @@ and then you'll got todo app as same as Demo. let's modify under the `src/` code
8287

8388
Production build that bundled optimization stuff in `build` directory.
8489

90+
### `yarn serve`
91+
92+
Run production build that generated by `yarn build`.
8593

8694
### `yarn lint`
8795

@@ -103,6 +111,14 @@ Check TypeScript error whole porject.
103111
Run [Jest](https://jestjs.io/).
104112
Using [react-testing-library](https://github.com/testing-library/react-testing-library) for component integration testing.
105113

114+
### `yarn clean`
115+
116+
Delete `node_modules/*`, `yarn.lock`, `build/*` once.
117+
118+
### `yarn prettier`
119+
120+
Run prettier formatting holeproject without all JS/TS files.
121+
106122
### `yarn cypress:open`
107123

108124
[Cypress](https://www.cypress.io/) is all-in-one E2E Testing tool which can deal testing on real browser.

0 commit comments

Comments
 (0)