Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/idea2app/vue-mobx-prime-ts
Vue 3 project scaffold based on TypeScript 5, MobX & PrimeVue 3, which is inspired by WebCell scaffold.
https://github.com/idea2app/vue-mobx-prime-ts
bootstrap scaffold typescript vue
Last synced: 2 months ago
JSON representation
Vue 3 project scaffold based on TypeScript 5, MobX & PrimeVue 3, which is inspired by WebCell scaffold.
- Host: GitHub
- URL: https://github.com/idea2app/vue-mobx-prime-ts
- Owner: idea2app
- Created: 2020-12-03T17:06:37.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-14T21:45:43.000Z (8 months ago)
- Last Synced: 2024-06-15T22:24:36.018Z (8 months ago)
- Topics: bootstrap, scaffold, typescript, vue
- Language: Vue
- Homepage: https://idea2app.github.io/Vue-MobX-Prime-ts/
- Size: 4.44 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vue-MobX-Prime-ts
[Vue 3][1] project scaffold based on [TypeScript 5][2], [MobX][3] & [PrimeVue 3][4], which is inspired by [WebCell scaffold][5].
[][6]
[][7]
[][8]
This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 `` SFCs, check out the [script setup docs][9] to learn more.
## Knowledge
- Language: [TypeScript 5][2]
- Component engine: [Vue 3][1]
- Component suite: [PrimeVue 3][4]
- Chart library: [ECharts-JSX 1][10]
- State management: [MobX v6][3]
- HTTP client: [KoAJAX 1][11]
- Asset bundler: [Parcel 2][12]
## Extra components
1. [`<StockNumber />`](src/components/StockNumber.vue)
2. [`<Overlay />`](src/components/Overlay.vue)
3. [`<Image />`](src/components/Image.vue)
4. [`<ImageUploader />`](src/components/ImageUploader.vue)
5. [`<Downloader />`](src/components/Downloader.vue)
## Best practice
1. Install GitHub apps in your organization or account:
1. [Probot settings][13]: set up Issue labels & Pull Request rules
2. [PR badge][14]: set up Online [VS Code][15] editor entries in Pull Request description
2. Click the **[Use this template][16] 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][7] button** on the top of ReadMe file, then an **online VS Code development environment** will be started immediately
4. Set [Vercel variables][17] as [Repository secrets][18], then every commit will get an independent **Preview URL**
5. Recommend to add a [Notification step in GitHub actions][19] for your Team IM app
6. Remind the PMs & users of your product to submit **Feature/Enhancement** requests or **Bug** reports with [Issue forms][20] instead of IM messages or Mobile Phone calls
7. Collect all these issues into [Project kanbans][21], then create **Pull requests** & add `closes #issue_number` into its description for automation
## Usage
### Project setup
```Shell
npm i pnpm -g
pnpm i
```
### Compiles and hot-reloads for development
```Shell
npm start
```
### Compiles and minifies for production
```Shell
pnpm build
```
### Lints and fixes files
```Shell
npm test
```
## Recommended IDE Setup
- [VSCode][15] + [Volar][22]
### Type Support For `.vue` Imports in TS
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's `.vue` type support plugin by running `Volar: Switch TS Plugin on/off` from VSCode command palette.
[1]: https://vuejs.org/
[2]: https://www.typescriptlang.org/
[3]: https://mobx.js.org/
[4]: https://primevue.org/
[5]: https://github.com/EasyWebApp/scaffold
[6]: https://github.com/idea2app/Vue-MobX-Prime-ts/actions/workflows/main.yml
[7]: https://codespaces.new/idea2app/Vue-MobX-Prime-ts
[8]: https://gitpod.io/?autostart=true#https://github.com/idea2app/Vue-MobX-Prime-ts
[9]: https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup
[10]: https://github.com/idea2app/ECharts-JSX
[11]: https://github.com/EasyWebApp/KoAJAX
[12]: https://parceljs.org/
[13]: https://probot.github.io/apps/settings/
[14]: https://pullrequestbadge.com/
[15]: https://code.visualstudio.com/
[16]: https://github.com/new?template_name=Vue-MobX-Prime-ts&template_owner=idea2app
[17]: https://github.com/idea2app/Next-Bootstrap-ts/blob/80967ed49045af9dbcf4d3695a2c39d53a6f71f1/.github/workflows/pull-request.yml#L9-L11
[18]: https://github.com/idea2app/Vue-MobX-Prime-ts/settings/secrets/actions
[19]: https://github.com/kaiyuanshe/kaiyuanshe.github.io/blob/bb4675a56bf1d6b207231313da5ed0af7cf0ebd6/.github/workflows/pull-request.yml#L32-L56
[20]: https://github.com/idea2app/Vue-MobX-Prime-ts/issues/new/choose
[21]: https://github.com/idea2app/Vue-MobX-Prime-ts/projects
[22]: https://marketplace.visualstudio.com/items?itemName=vue.volar