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-09-04 08:52:28 +12:00
> Playwright tests run from built, live version of FA. Therefore, to run them, you need to localy build the app on your machine first - Both on first time using them and every time something is changed in the source code.
2023-08-26 23:39:49 +12:00
## 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)
2023-08-29 10:05:58 +12:00
```
2023-08-26 23:39:49 +12:00
yarn global add @quasar/cli
```
2023-08-19 20:43:21 +12:00
## Install the dependencies and set up the project
2023-08-29 10:05:58 +12:00
```
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.)
2023-08-29 10:05:58 +12:00
```
2023-08-19 20:43:21 +12:00
quasar dev -m electron
2021-07-10 04:38:42 +12:00
```
### Build the app for production
2023-08-29 10:05:58 +12:00
```
2021-07-10 04:38:42 +12:00
quasar build
```
2023-08-25 08:40:07 +12:00
### Testing:
2023-08-29 10:05:58 +12:00
2023-08-26 23:39:49 +12:00
#### Unit test - with pretty web-UI
2023-08-29 10:05:58 +12:00
```
2023-08-25 08:40:07 +12:00
test:unit:ui
```
2023-09-04 06:36:10 +12:00
#### Unit test - Without any UI, fully in a terminal
2023-08-25 08:40:07 +12:00
```
2023-08-29 10:05:58 +12:00
test:unit:ci
```
2023-09-04 06:36:10 +12:00
#### Component test - via Playwright
2023-08-29 10:05:58 +12:00
```
2023-09-04 06:36:10 +12:00
test:component
2023-08-29 10:05:58 +12:00
```
2023-09-04 06:36:10 +12:00
#### E2E test - via Playwright
2023-08-25 08:40:07 +12:00
```
2023-09-04 06:36:10 +12:00
test:e2e
2023-08-25 08:40:07 +12:00
```
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 ).