Skip to content

Commit eefdac2

Browse files
Merge branch 'main' of github.com:laststance/react-typescript-todomvc-2022
2 parents 927ca5f + c279652 commit eefdac2

File tree

1 file changed

+27
-19
lines changed

1 file changed

+27
-19
lines changed

README.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Almost cases, there is no value that spending time for rerwite new syntax sugar
2323

2424
So this project aming new React learner and who have not written React for a long time and provide handy resource for lerning latest React.js. o
2525

26-
I'm glad to even the repo could be useful for your learning. 🤗3
26+
I'm glad to even the repo could be useful for your learning. 🤗
2727

2828
[![Edit react-typescript-todomvc-2022](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/quizzical-blackwell-bvfc5?fontsize=14&hidenavigation=1&theme=dark)
2929

@@ -59,19 +59,23 @@ after that auto launch todo app on your default browser and code edit ready.
5959
- [TODO-CSS-Template](https://github.com/Klerith/TODO-CSS-Template) (Borrowing HTML & CSS Thanks! 👍 )
6060
- [Vite](https://vitejs.dev/)
6161
- [TypeScript](https://www.typescriptlang.org/) [v4.2.4](https://github.com/microsoft/TypeScript/releases/tag/v4.2.4)
62-
- [ReachRouter](https://github.com/reach/router)
62+
- [Reacct Router](https://reactrouter.com/)
6363
- [Styled-Components](https://styled-components.com/): CSS-in-JS
6464
- [Recoil](https://recoiljs.org/): A state management library for React
6565
- [Cypress](https://www.cypress.io/): E2E Testing
6666
- [react-testing-library](https://github.com/testing-library/react-testing-library)
6767
- [ESLint](https://eslint.org/)
68-
- [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier)
69-
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint#readme)
68+
- [eslint-config-typescript-react-pro 🌈](https://github.com/laststance/eslint-config-typescript-react-pro)
7069
- [Netlify](https://www.netlify.com/): Deploy & Hosting
7170
- [Github Actions](https://github.com/features/actions): Automation run tests, lint, typecheck, build
7271
- [Depfu](https://depfu.com/github/ryota-murakami/react-typescript-todomvc-2022?project_id=9618): Keep latest npm packages automaticaly
7372

74-
## 👩‍💻 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.
7579

7680
### `yarn start`
7781

@@ -81,35 +85,39 @@ and then you'll got todo app as same as Demo. let's modify under the `src/` code
8185

8286
### `yarn build`
8387

84-
After that You'll get bundled and optimization stuff in `build` directory.
85-
Also you can run production build with `serve` local webserver modules.
88+
Production build that bundled optimization stuff in `build` directory.
8689

87-
```bash
88-
yarn global add serve
89-
serve -s build
90-
```
90+
### `yarn serve`
9191

92-
Official Docs: https://create-react-app.dev/docs/getting-started#npm-run-build-or-yarn-build
92+
Run production build that generated by `yarn build`.
9393

9494
### `yarn lint`
9595

9696
[ESLint](https://eslint.org/) is at the top.
97-
And setup [TypeScript ESLint](https://github.com/typescript-eslint/typescript-eslint), integrating [Prettier](https://prettier.io/) as a [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier).
97+
And setup [TypeScript ESLint](https://github.com/typescript-eslint/typescript-eslint), integrating [Prettier](https://prettier.io/) as a [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier).
98+
Here is [final config list](https://github.com/laststance/eslint-config-typescript-react-pro#explicit-all-rule-set-).
9899

99100
### `yarn lint:fix`
100101

101-
run wtih eslint --fix option.
102+
Run wtih eslint --fix option.
103+
Actually frequently use for perform [Prettier](https://prettier.io/) formatting.
102104

103105
### `yarn typecheck`
104106

105-
While developing and building, Babel stop transpile with TS error messages.
106-
I can't find way static typecheck with babel,
107-
so I'm using original TypeScript via npm and specified `tsc --noEmit` compile option that doesn't generate compiled code.
107+
Check TypeScript error whole porject.
108108

109109
### `yarn test`
110110

111-
[Jest](https://jestjs.io/) is all-in-one test-runner built in [React App](https://facebook.github.io/create-react-app/) and covers function-level unit testing to component-behavior-level integration testing.
112-
The Repo use to [react-testing-library](https://github.com/testing-library/react-testing-library) for component integration testing.
111+
Run [Jest](https://jestjs.io/).
112+
Using [react-testing-library](https://github.com/testing-library/react-testing-library) for component integration testing.
113+
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.
113121

114122
### `yarn cypress:open`
115123

0 commit comments

Comments
 (0)