ReadMe.md

React-MobX-MUI-ts

React project scaffold based on TypeScript, MobX & Material UI, which is inspired by WebCell scaffold.

Technology stack

• Language: TypeScript v5
• Component engine: React v18
• State management: MobX v6
• Component suite: Material UI
• HTTP Client: KoAJAX v1
• PWA framework: Workbox v7
• Package bundler: Parcel v2
• CI / CD: GitHub Actions + Pages

Extra components

1. Component Sample
2. Rich-text editor
   • HTML version
   • JSON version
3. GitHub logo
4. GitHub card

Best practice

1. Install GitHub apps in your organization or account:

   1. Probot settings: set up Issue labels & Pull Request rules
   2. PR badge: set up Online VS Code editor entries in Pull Request description

2. Click the Use this template button on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above

3. Click the Open in GitHub codespaces button on the top of ReadMe file, then an online VS Code development environment will be started immediately

4. Set Vercel variables as Repository secrets, then every commit will get an independent Preview URL

5. Recommend to add a Notification step in GitHub actions for your Team IM app

6. Remind the PMs & users of your product to submit Feature/Enhancement requests or Bug reports with Issue forms instead of IM messages or Mobile Phone calls

7. Collect all these issues into Project kanbans, then create Pull requests & add closes #issue_number into its description for automation

Development

npm i pnpm -g

pnpm i

npm start

Deployment

pnpm build