Skip to content

Latest commit

 

History

History
227 lines (153 loc) · 12.7 KB

README.md

File metadata and controls

227 lines (153 loc) · 12.7 KB
Raw

Project Status from the Author (@ryota-murakami, Aug 16 2023):

I'm considering continue update as a Client Side SPA or Rewrite this app with Server Components.
But Server Components doen't meant obsolete Client Side SPA, both archtecture is great option depends on application type, dev team type, each dev's skillset type.

Might be keep update both archtecture TODO is ideal vision for me unless there are planty rest time.
Anyway, I thnik was TODO MVC outdated for current JS frameworks.
I want to renew this project about this winter.

React TypeScript TodoMVC 2022

Netlify Status Build Cypress E2E Lint Test code style: prettier Typecheck All Contributors This project is using Percy.io for visual regression testing.

gif

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 complain about it because the old-style codebase React app works all over the world and helps peopleAlmost cases, there is no value that spending time for rerwite new syntax sugar of huge codebase.

This project aims to assist new React learners and those who have not written React for a long time by providing a handy resource for learning the latest React.js. I'm glad to even the repo could be useful for your learning. 🤗

Edit react-typescript-todomvc-2022

Getting Started

  • The app assumes that you have installed Node.js newer than v18.16.1 LTS. If you don't have 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
npm -g pnpm
pnpm i
pnpm start

after that auto launch todo app on your default browser and code edit ready.

Stack

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

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
ryota-murakami
💻 📖 ⚠️		 Will Roscoe
Will Roscoe
💻		 Peng Fei
Peng Fei
🐛		 Alex Panchuk
Alex Panchuk
📖		 Burhan Mullamitha
Burhan Mullamitha
📖		 hefengxian
hefengxian
💻 ⚠️		 Ethan Setnik
Ethan Setnik
📖
Paolo Nessim
Paolo Nessim
💻		 Li Kui
Li Kui
💻		 Adarsh Gupta
Adarsh Gupta
📖

This project follows the all-contributors specification. Contributions of any kind welcome!