advent22/ui/README.md

55 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2022-10-28 00:14:20 +00:00
# advent22_ui
This template should help get you started developing with Vue 3 in Vite.
2024-08-27 00:25:42 +00:00
## Recommended IDE Setup
2022-10-28 00:14:20 +00:00
[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
2024-08-27 00:25:42 +00:00
## Recommended Browser Setup
- Chromium-based browsers (Chrome, Edge, Brave, etc.):
- [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
- [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters)
- Firefox:
- [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/)
- [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/)
## Type Support for `.vue` Imports in TS
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
## Customize configuration
See [Vite Configuration Reference](https://vite.dev/config/).
## Project Setup
```sh
yarn
2022-10-28 00:14:20 +00:00
```
### Compile and Hot-Reload for Development
2024-08-27 00:25:42 +00:00
```sh
yarn dev
2022-10-28 00:14:20 +00:00
```
### Type-Check, Compile and Minify for Production
```sh
2022-10-28 00:14:20 +00:00
yarn build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
2024-08-27 00:25:42 +00:00
```sh
yarn test:unit
2022-10-28 00:14:20 +00:00
```
### Lint with [ESLint](https://eslint.org/)
2024-08-27 00:25:42 +00:00
```sh
yarn lint
```