react-typescript-todomvc-2022
react-typescript-todomvc-2022 copied to clipboard
React TypeScript TodoMVC 2022
React TypeScript TodoMVC 2022
A Modern Code Style Todo Example 📝
This project was started with the goal of continue to publish TodoMVC Apps in the latest React writing style.
When you found React.js on TodoMVC top page, you might seen classic style React.createClass()
based source at first.
I don't complaining about it because old style codebase React app works all over the world and helps people.
Almost cases, there is no value that spending time for rerwite new syntax sugar of huge codebase.
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
I'm glad to even the repo could be useful for your learning. 🤗
Getting Started
- The app assumed installed
Node.js
newer than v16.15.1 LTS. If you have not it yet, follow the official Node.js Doc to install it.
npx degit laststance/react-typescript-todomvc-2022 react-typescript-todomvc-2022
cd react-typescript-todomvc-2022
yarn install # or npm install
yarn start # or npm start
after that auto launch todo app on your default browser and code edit ready.
Stack
- TODO-CSS-Template (Borrowing HTML & CSS Thanks! 👍 )
- Vite
- TypeScript v4.2.4
- Reacct Router
- Styled-Components: CSS-in-JS
- Recoil: A state management library for React
- Cypress: E2E Testing
- react-testing-library
- ESLint
- Netlify: Deploy & Hosting
- Github Actions: Automation run tests, lint, typecheck, build
- Depfu: Keep latest npm packages automaticaly
Command
You can do exact same command with npm, or install yarn easily if you have interest.
yarn
or yarn install
Install all Node Package Modules that depending this project.
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!!
yarn build
Production build that bundled optimization stuff in build
directory.
yarn serve
Run production build that generated by yarn build
.
yarn lint
ESLint is at the top.
And setup TypeScript ESLint, integrating Prettier as a eslint-plugin-prettier.
Here is final config list.
yarn lint:fix
Run wtih eslint --fix option.
Actually frequently use for perform Prettier formatting.
yarn typecheck
Check TypeScript error whole porject.
yarn test
Run Jest.
Using react-testing-library for component integration testing.
yarn clean
Delete node_modules/*
, yarn.lock
, build/*
once.
yarn prettier
Run prettier formatting holeproject without all JS/TS files.
yarn cypress:open
Cypress is all-in-one E2E Testing tool which can deal testing on real browser.
This command using Electron by Cypress default.
yarn cypress:open
require yarn start
before.
yarn start # Launch DevServer
yarn cypress:open
yarn cypress:run
Run Cypress with Electron.
That's same as run all test on cypress GUI after run yarn cypress:open
.
yarn start # Launch DevServer
yarn cypress:run
yarn cypress:run:headless
Run Cypress with headless Electron.
That mean this command complete all on a terminal without GUI.
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 or Pull Request 🤗
Questions
Please feel free to post New Issue or reply on Twitter 🐦
If you want to get more generally answers, these community are might be helpful 🍻
LICENSE
MIT
Contributors
Thanks goes to these wonderful people (emoji key):
ryota-murakami 💻 📖 ⚠️ |
Will Roscoe 💻 |
Peng Fei 🐛 |
Alex Panchuk 📖 |
Burhan Mullamitha 📖 |
hefengxian 💻 ⚠️ |
Ethan Setnik 📖 |
Paolo Nessim 💻 |
Li Kui 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!