README.md

The Gregorovius Frontend repo contains the main frontend of the Gregorovius Correspondence Edition and the Edition Guidelines.

Main frontend

The edition's main frontend is built as a SPA with Vue.js, Vue CLI and Quasar.

Setup for development

Make sure you have npm installed, cd into the root project directory and run

npm install

to install all required dependencies.

Copy the env.dist.js to env.js and change the contents if necessary.

cp env.dist.js env.js

To compile and hot-reload for development run

npm run serve

Testing

This project used Jest as its main testing framework.

Run tests with:

npm run test

Edition Guidelines

The edition guidelines are built with MkDocs and Material for MkDocs. The content is all markdown-based and the structure of the page can be configured with a central configuration file (see the MkDocs documentation).

Setup for development

Make sure you have Python and MkDocs installed, cd into the edition-docs directory and run

mkdocs serve