aboutsummaryrefslogtreecommitdiff
path: root/frontend/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'frontend/README.md')
-rw-r--r--frontend/README.md46
1 files changed, 0 insertions, 46 deletions
diff --git a/frontend/README.md b/frontend/README.md
deleted file mode 100644
index 1270ce5..0000000
--- a/frontend/README.md
+++ /dev/null
@@ -1,46 +0,0 @@
1# frontend
2
3This template should help get you started developing with Vue 3 in Vite.
4
5## Recommended IDE Setup
6
7[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
8
9## Type Support for `.vue` Imports in TS
10
11TypeScript 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 [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
12
13If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
14
151. Disable the built-in TypeScript Extension
16 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
17 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
182. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
19
20## Customize configuration
21
22See [Vite Configuration Reference](https://vitejs.dev/config/).
23
24## Project Setup
25
26```sh
27npm install
28```
29
30### Compile and Hot-Reload for Development
31
32```sh
33npm run dev
34```
35
36### Type-Check, Compile and Minify for Production
37
38```sh
39npm run build
40```
41
42### Lint with [ESLint](https://eslint.org/)
43
44```sh
45npm run lint
46```