aboutsummaryrefslogtreecommitdiffstats
path: root/frontend/README.md
diff options
context:
space:
mode:
authorLeonardo Bishop <me@leonardobishop.com>2023-11-04 15:25:06 +0000
committerLeonardo Bishop <me@leonardobishop.com>2023-11-04 15:25:06 +0000
commit9f83ab70cfd5f2c41a23593f8ee5065b1015e242 (patch)
treed5bc21382cf3e5e38db6af5ab0f6e2ad5ef37c86 /frontend/README.md
parentef7a5e4cc01cfdc4a2594cb408a1dfd889ebb51f (diff)
Add frontend
Diffstat (limited to 'frontend/README.md')
-rw-r--r--frontend/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/frontend/README.md b/frontend/README.md
new file mode 100644
index 0000000..2c23c18
--- /dev/null
+++ b/frontend/README.md
@@ -0,0 +1,40 @@
+# frontend
+
+This template should help get you started developing with Vue 3 in Vite.
+
+## Recommended IDE Setup
+
+[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).
+
+## 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 [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.
+
+If 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:
+
+1. Disable the built-in TypeScript Extension
+ 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
+ 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
+2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+npm run build
+```