https://github.com/dirheimerb/type-todo
https://github.com/dirheimerb/type-todo
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/dirheimerb/type-todo
- Owner: dirheimerb
- License: mit
- Created: 2022-04-04T03:31:19.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T03:48:46.000Z (over 3 years ago)
- Last Synced: 2025-02-01T07:28:58.008Z (over 1 year ago)
- Language: TypeScript
- Size: 13.6 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create React App TypeScript Todo Example 2022
[](https://app.netlify.com/sites/create-react-app-typescript-todo-example/deploys)
[](https://www.cypress.io/)
[](https://github.com/facebook/jest)
[](https://github.com/prettier/prettier)
[](#contributors)
[](https://depfu.com/github/laststance/create-react-app-typescript-todo-example-2022?project_id=9618)
[](https://percy.io/laststance/create-react-app-typescript-todo-example-2022)
## A Modern Code Style Todo Example 📝
This project was started with the goal of continuing to publish Todo Example Apps in the latest [React](https://reactjs.org/) writing style.
When [React Hooks unveiled in autumn 2018](https://reactjs.org/blog/2018/11/13/react-conf-recap.html), I was looking for todo apps that written by new style [Function Component](https://reactjs.org/docs/components-and-props.html#function-and-class-components) and [Hooks](https://reactjs.org/docs/hooks-intro.html) to learn how to use them in real applications but I couldn't find any at that time.
Not only that, many of the results were written in [ES5](https://en.wikipedia.org/wiki/ECMAScript#5th_Edition) (using React.createClass() API), which was an older JavaScript generation in autumn 2018.
At that time, I thought there is a demand to keep updating and publishing with a modern code style even it is simple example like Todo App.
The project is targeting for who have completed a basic JavaScript programming course and new to React, peaople who migrating to React from another JavaScript Framework, and you have used to React in the past and want to catch up on the modern way for write back again.
I'm glad to even the repo could be useful for your learning. 🤗
[](https://codesandbox.io/s/quizzical-blackwell-bvfc5?fontsize=14&hidenavigation=1&theme=dark)
---------------
## Getting Started
- The app assumed installed `Node.js` newer than `10.16.3 LTS`(recommend newer than v14.8.0).
If you have not it yet, follow the official [Node.js Doc](https://nodejs.org/en/) to install it.
```bash
npx degit laststance/create-react-app-typescript-todo-example-2022 create-react-app-typescript-todo-example-2022
```
```bash
cd create-react-app-typescript-todo-example-2022
```
```bash
yarn install
```
```bash
yarn start
```
after that auto launch todo app on your default browser and code edit ready.
----------------------------------------------------------
## Stack
- [TODO-CSS-Template](https://github.com/Klerith/TODO-CSS-Template) (Borrowing HTML & CSS Thanks! 👍 )
- [Create React App](https://github.com/facebook/create-react-app/releases/tag/v4.0.3) [v4.0.3](https://github.com/facebook/create-react-app/releases/tag/v4.0.3) (**Without eject**)
- [TypeScript](https://www.typescriptlang.org/) [v4.2.4](https://github.com/microsoft/TypeScript/releases/tag/v4.2.4)
- [ReachRouter](https://github.com/reach/router)
- [Styled-Components](https://styled-components.com/): CSS-in-JS
- [Recoil](https://recoiljs.org/): A state management library for React
- [Cypress](https://www.cypress.io/): E2E Testing
- [react-testing-library](https://github.com/testing-library/react-testing-library)
- [ESLint](https://eslint.org/)
- [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier)
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint#readme)
- [Netlify](https://www.netlify.com/): Deploy & Hosting
- [Github Actions](https://github.com/features/actions): Automation run tests, lint, typecheck, build
- [Depfu](https://depfu.com/github/ryota-murakami/create-react-app-typescript-todo-example-2022?project_id=9618): Keep latest npm packages automaticaly
## 👩💻 Usage
### `yarn start`
After that you'll seen the console which are server processes messages.
Let's follow the message and put in URL `http://localhost:3000/` your browsers adressbar,
and then you'll got todo app as same as Demo. let's modify under the `src/` code feel free!!
Official Docs: https://create-react-app.dev/docs/getting-started#npm-start-or-yarn-start
### `yarn build`
After that You'll get bundled and optimization stuff in `build` directory.
Also you can run production build with `serve` local webserver modules.
```bash
yarn global add serve
serve -s build
```
Official Docs: https://create-react-app.dev/docs/getting-started#npm-run-build-or-yarn-build
### `yarn lint`
[ESLint](https://eslint.org/) is at the top.
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).
### `yarn lint:fix`
run wtih eslint --fix option.
### `yarn typecheck`
While developing and building, Babel stop transpile with TS error messages.
I can't find way static typecheck with babel,
so I'm using original TypeScript via npm and specified `tsc --noEmit` compile option that doesn't generate compiled code.
### `yarn test`
[Jest](https://jestjs.io/) is all-in-one test-runner built in [Create React App](https://facebook.github.io/create-react-app/) and covers function-level unit testing to component-behavior-level integration testing.
The Repo use to [react-testing-library](https://github.com/testing-library/react-testing-library) for component integration testing.
### `yarn cypress:open`
[Cypress](https://www.cypress.io/) is all-in-one E2E Testing tool which can deal testing on real browser.
This command using [Electron](https://www.electronjs.org/) by Cypress default.
`yarn cypress:open` require `yarn start` before.
```bash
yarn start # Launch DevServer
yarn cypress:open
```
### `yarn cypress:run`
Run Cypress with [Electron](https://www.electronjs.org/).
That's same as run all test on cypress GUI after run `yarn cypress:open`.
```bash
yarn start # Launch DevServer
yarn cypress:run
```
### `yarn cypress:run:headless`
Run Cypress with headless [Electron](https://www.electronjs.org/).
That mean this command complete all on a terminal without GUI.
```bash
yarn start # Launch DevServer
yarn cypress:run:headless
```
## 🗒 Note
**This is not a Best Practice introduction.
There are tons of effective way to create solid software in JavaScript World, you have a lot of other option based on your preference for approaching where, The Repo is just a style of my favorite.**
"_How to combining TypeScript with massive Babel or JavaScript tools ecosystem?_"
**I hope this helps you know like that from what I've Published!**
## Issues
Please feel free to post [New Issue](https://github.com/laststance/create-react-app-typescript-todo-example-2022/issues/new) or Pull Request 🤗
## Questions
Please feel free to post [New Issue](https://github.com/laststance/create-react-app-typescript-todo-example-2022/issues/new) or reply on [Twitter](https://twitter.com/malloc007) 🐦
If you want to get more generally answers, these community are might be helpful 🍻
- [Reactiflux on Discord](https://www.reactiflux.com/)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/reactjs)
## LICENSE
MIT
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
ryota-murakami
💻 📖 ⚠️
Will Roscoe
💻
Peng Fei
🐛
Alex Panchuk
📖
Burhan Mullamitha
📖
hefengxian
💻 ⚠️
Ethan Setnik
📖
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!