fantasia-archive/README.md

Fantasia Archive (fantasia-archive)

A worldbuilding database manager

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

Start the app in Quasar development mode (hot-code reloading, error reporting, etc.)

quasar dev -m electron

Build the app for production

quasar build

Testing:

Unit test - with pretty web-UI

test:unit:ui

Unit test - without any UI, fully in a terminal

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)

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)

test:e2e

Customize the configuration

See Configuring quasar.config.js.