Go to file
2023-09-03 00:16:57 +02:00
.github/workflows Fixed & working Github actions build on all OSs 2023-08-26 23:33:00 +02:00
.vscode Added support for electron testing via Playwright 2023-09-03 00:16:57 +02:00
public First commit of the 2023 version of FA 2023-08-19 10:43:21 +02:00
src Cleaned up frontend testing & Readme file 2023-08-29 00:05:58 +02:00
src-electron Added global window control buttons component 2023-08-27 18:52:26 +02:00
test Added support for electron testing via Playwright 2023-09-03 00:16:57 +02:00
.editorconfig First new FA commit 2021-07-09 18:38:42 +02:00
.eslintignore First commit of the 2023 version of FA 2023-08-19 10:43:21 +02:00
.eslintrc.cjs Added global window control buttons component 2023-08-27 18:52:26 +02:00
.gitignore First commit with working test of all types 2023-08-24 22:40:07 +02:00
.npmrc First commit of the 2023 version of FA 2023-08-19 10:43:21 +02:00
.nycrc First commit with working test of all types 2023-08-24 22:40:07 +02:00
cypress.config.ts Cleaned up frontend testing & Readme file 2023-08-29 00:05:58 +02:00
index.html First commit of the 2023 version of FA 2023-08-19 10:43:21 +02:00
package.json Added support for electron testing via Playwright 2023-09-03 00:16:57 +02:00
postcss.config.cjs First commit of the 2023 version of FA 2023-08-19 10:43:21 +02:00
quasar.config.js Github build workflow fixes 2023-08-26 23:01:46 +02:00
quasar.extensions.json First commit with working test of all types 2023-08-24 22:40:07 +02:00
quasar.testing.json First commit with working test of all types 2023-08-24 22:40:07 +02:00
README.md Typo fix 2023-09-01 23:09:19 +02:00
tsconfig.json Added global window control buttons component 2023-08-27 18:52:26 +02:00
vitest.config.ts First commit with working test of all types 2023-08-24 22:40:07 +02:00
yarn.lock Added support for electron testing via Playwright 2023-09-03 00:16:57 +02:00

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:

Keep in mind that Cypress tests are limited to front-end testing due to the nature of Electron's nodeJS-based backend. Anything in Electron's main and preload will NOT work.

Unit test - with pretty web-UI

test:unit:ui

Unit test - without any UI, fully in a terminal

test:unit:ci

Component test, Frontend - 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:frontend

E2E test, Frontend - 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:frontend

Customize the configuration

See Configuring quasar.config.js.