The frontend is a Vue.js v2 application. It contains a Leaflet based map application to visualize data. A catalog to display the coinage, as known from other scientific documents. And a content-management layer for the editors to create and edit the catalog entries and their corresponding attributes (e.g. mint, material, persons, ...).
- nodejs
- yarn (optional)
- vscode (recommended IDE)
- sikka-backend
The project is using yarn to manage dependencies (primarily because it is faster). You may use npm, but it may result in errors as the ones stored are from yarn.
Visual Studio Code is recommended, not only because it's awesome features (like multi-line editing) and extendability using plugins
Setup the sikka-buya backend first before continuing!
Install yarn (if not installed yet)
npm install -g yarn
Install the dependencies with yarn.
yarn install
# alternatively (not recommended) you may use
# npm installNote: If you need to add dependencies make sure to use: yarn add <your_dependency>
Normally, you will always run the frontend together with the backend. Therefore a task was created for vscode
To run the frontend you must setup the project first and then run the project with the following command.
npm run serve
Note: All changes will be live-reloaded. So you can just write your code and see the changes update in real-time.
To deploy the project on a UNIX based server, you can simply use the deploy.sh script:
...\sikka-buya\frontend> . deploy.sh