diff options
| author | Leonardo Bishop <me@leonardobishop.com> | 2024-03-10 01:45:54 +0000 |
|---|---|---|
| committer | Leonardo Bishop <me@leonardobishop.com> | 2024-03-10 01:45:54 +0000 |
| commit | 5def5ad30934b13193e4b0d9e291025255b21ff4 (patch) | |
| tree | c8aee8089c1d6449969d6300716e752cfb9dd526 /README.md | |
| parent | 6f8d5a2356ca4e96ec510c905530056fa424034c (diff) | |
Update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 3 insertions, 43 deletions
@@ -1,46 +1,6 @@ # quests-web-editor -This template should help get you started developing with Vue 3 in Vite. +This is the repository for the [Quests](https://github.com/LMBishop/Quests) web +editor, which is currently a work in progress. -## 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 -``` - -### Lint with [ESLint](https://eslint.org/) - -```sh -npm run lint -``` +It is written with [Nuxt 3](https://nuxt.com/). |