Siminon/justone
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Explain better in the r eadme

Browse Source
This commit is contained in:
Schmop 2023-07-16 18:59:56 +02:00
parent f30bdcf8b2
commit 31ed9313be
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,27 +1,25 @@
# justone # Just One
This template should help get you started developing with Vue 3 in Vite. A simple cooperative party game.
Guess the secret words, support the active guesser with associations on small white boards.
But don't talk to each other!
## Recommended IDE Setup https://www.asmodee.de/produkte/just-one
[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). ## Local hosting
## Type Support for `.vue` Imports in TS ### Initial install
```
npm ci
npm run build
```
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. ### Serving the files
```
python -m http.server -d dist
```
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: ## Development
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 ```sh
npm install npm install