Vue-MobX-Prime-ts

Vue 3 project scaffold based on TypeScript 5, MobX & PrimeVue 3, which is inspired by WebCell scaffold.

This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

Knowledge

• Language: TypeScript 5 + ES Decorator (stage-3)
• Component engine: Vue 3
• Component suite: PrimeVue 4
• Chart library: ECharts-JSX 1
• State management: MobX 6
• HTTP client: KoAJAX 3
• Asset bundler: Parcel 2

Extra components

1. <StockNumber />
2. <Overlay />
3. <Image />
4. <ImageUploader />
5. <Downloader />

MobX Observer decorator

This scaffold uses the mobx-vue-helper package, which provides an @observer decorator that makes Vue components reactive to MobX observable state changes, similar to mobx-react. It supports both class components and function components.

Usage with Class components

import { Vue, Component, toNative } from 'vue-facing-decorator';
import { observer } from 'mobx-vue-helper';

import counterStore from './models/Counter';

@Component
@observer
class MyMobX extends Vue {
  render() {
    return (
      <button onClick={() => counterStore.increment()}>
        Count: {counterStore.count}
      </button>
    );
  }
}
export default toNative(MyMobX);

Usage with Function components

import { observer } from 'mobx-vue-helper';

import counterStore from './models/Counter';

export const MyMobX = observer(() => (
  <button onClick={() => counterStore.increment()}>
    Count: {counterStore.count}
  </button>
));

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

Usage

Project setup

npm i pnpm -g
pnpm i

Compiles and hot-reloads for development

npm start

Compiles and minifies for production

pnpm build

Lints and fixes files

npm test

Recommended IDE Setup

• VSCode + TypeScript official extension + Prettier formatter extension

Ditch Volar and go back to the official TypeScript and Prettier extensions for a high-performance, high-quality development experience.