CodeMirror/fantasia-archive
1
0
Fork 0
mirror of https://github.com/Elvanos/fantasia-archive.git synced 2024-05-04 12:23:18 +12:00
Code Issues Projects Releases Wiki Activity

Cleaned up package.json commands and readme.md

Browse source
This commit is contained in:
Elvanos 2023-08-26 13:39:49 +02:00
parent a50671c3c1
commit 808ddaafc1
2 changed files with 14 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -6,6 +6,15 @@ Use Yarn 1.22.19 or stuff is gonna bug out.
Make sure you are running this with Node v16.17.0 ("nvm" is great for these older versions)
## Install Quasar CLI for smoothest experience
##### Details found here: https://quasar.dev/start/quasar-cli
##### Ensure that the Yarn global install location is in your PATH after install. (details in article linked above)
```bash
yarn global add @quasar/cli
```
## Install the dependencies and set up the project
```bash
yarn
@ -16,11 +25,6 @@ yarn
quasar dev -m electron
```
### Lint the files manually (you can do this, but like... use an plugin of some kind in your IDE please T_T)
```bash
yarn lint
```
### Build the app for production
```bash
quasar build
@ -28,19 +32,19 @@ quasar build
### Testing:
##### Unit test - with pretty web-UI
#### Unit test - with pretty web-UI
```bash
test:unit:ui
```
##### Unit test - without any UI, fully in a terminal
#### Unit test - without any UI, fully in a terminal
```bash
test:unit
```
##### Component test - via Cypress, pick Electron on the config screen (I suggest turning on the electron dev window first, the test is a bit buggy sometimes)
#### Component test - via Cypress, pick Electron on the config screen (I suggest turning on the electron dev window first, the test is a bit buggy sometimes)
```bash
test:component
```
##### e2e test - via Cypress, pick Electron on the config screen (I suggest turning on the electron dev window first, the test is a bit buggy sometimes)
#### e2e test - via Cypress, pick Electron on the config screen (I suggest turning on the electron dev window first, the test is a bit buggy sometimes)
```bash
test:e2e
```

3
package.json
View file

@ -7,8 +7,7 @@
"private": true,
"scripts": {
"lint": "eslint --ext .js,.ts,.vue ./",
"test": "echo \"See package.json => scripts for available tests.\" && exit 0",
"dev": "quasar dev",
"dev:electron": "quasar dev -m electron",
"build": "quasar build",
"test:unit:ui": "vitest --ui",
"test:unit": "vitest",