2023-08-19 20:43:21 +12:00
# Fantasia Archive (fantasia-archive)
2021-07-10 04:38:42 +12:00
2023-08-19 20:43:21 +12:00
A worldbuilding database manager
2021-07-10 04:38:42 +12:00
2023-08-19 20:43:21 +12:00
Use Yarn 1.22.19 or stuff is gonna bug out.
2023-08-25 08:40:07 +12:00
Make sure you are running this with Node v16.17.0 ("nvm" is great for these older versions)
2023-08-19 20:43:21 +12:00
## Install the dependencies and set up the project
2021-07-10 04:38:42 +12:00
```bash
2023-08-19 20:43:21 +12:00
yarn
2021-07-10 04:38:42 +12:00
```
2023-08-19 20:43:21 +12:00
### Start the app in Quasar development mode (hot-code reloading, error reporting, etc.)
2021-07-10 04:38:42 +12:00
```bash
2023-08-19 20:43:21 +12:00
quasar dev -m electron
2021-07-10 04:38:42 +12:00
```
2023-08-25 08:40:07 +12:00
### Lint the files manually (you can do this, but like... use an plugin of some kind in your IDE please T_T)
2021-07-10 04:38:42 +12:00
```bash
2023-08-19 20:43:21 +12:00
yarn lint
2021-07-10 04:38:42 +12:00
```
### Build the app for production
```bash
quasar build
```
2023-08-25 08:40:07 +12:00
### Testing:
##### Unit test - with pretty web-UI
```bash
test:unit:ui
```
##### 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)
```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)
```bash
test:e2e
```
2021-07-10 04:38:42 +12:00
### Customize the configuration
2023-08-19 20:43:21 +12:00
See [Configuring quasar.config.js ](https://v2.quasar.dev/quasar-cli-vite/quasar-config-js ).