fantasia-archive/README.md

55 lines
1.1 KiB
Markdown
Raw Normal View History

# Fantasia Archive (fantasia-archive)
2021-07-10 04:38:42 +12:00
A worldbuilding database manager
2021-07-10 04:38:42 +12:00
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)
```
yarn global add @quasar/cli
```
## Install the dependencies and set up the project
```
yarn
2021-07-10 04:38:42 +12:00
```
### Start the app in Quasar development mode (hot-code reloading, error reporting, etc.)
```
quasar dev -m electron
2021-07-10 04:38:42 +12:00
```
### Build the app for production
```
2021-07-10 04:38:42 +12:00
quasar build
```
### Testing:
#### Unit test - with pretty web-UI
```
test:unit:ui
```
#### Unit test - Without any UI, fully in a terminal
```
test:unit:ci
```
#### Component test - via Playwright
```
test:component
```
#### E2E test - via Playwright
```
test:e2e
```
2021-07-10 04:38:42 +12:00
### Customize the configuration
See [Configuring quasar.config.js](https://v2.quasar.dev/quasar-cli-vite/quasar-config-js).