Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.62 KB

README.md

File metadata and controls

73 lines (49 loc) · 2.62 KB
Raw

Shahi Kingdoms Database

About

Shahi Kingdoms Database is a presentation webapp for the Shahi Project.

At the moment we are still in development phase.

Shahi Kingdoms Database is an OpenAtlas projects and therefore OpenAtlasDiscovery was used as basi

Licensing

All code unless otherwise noted is licensed under the terms of the MIT License (MIT). Please refer to the file COPYING in the root directory of this repository.

All documentation and images unless otherwise noted are licensed under the terms of Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/

Technology

The web application is built using the nuxtjs framework based on Vuejs

Setup

Whilst the application ultimately runs in the browser and can be served from any web server developing and deploying it requires NodeJS (minimum v10, current LTS is recommended).

After cloning the repository, install all dependencies in the application root with

$ npm install

For Development

Serve with hot reload at localhost:3000

$ npm run dev

For Deployment

Generate the project files to /dist

$ npm run export

The resulting files in the /dist folder can be served from any web server or be exposed through nuxt using

npm run start

When you are serving the application from your own server (ie Apache) you need to configure it accordingly to avoid 404 responses on dynamically generated routes. Some examples can be found in the Vue Router Documentation

For detailed explanation on how things work, check out Nuxt.js docs.

Using the generated container image

Nuxt.js by default binds to localhost. This is not going to work in a container environment because in such an environment the service has to bind to an ip address assigned to that containber. This repository is setup to bind to any address if the container is run in an environment where the variable GITLAB_ENVIRONMENT_NAME is set (the value does not matter). E. g. for the latest master branch image on Windows or Linux using docker you can run the service like this

docker run --rm -it -p 8080:8080 -e PORT=8080 -e GITLAB_ENVIRONMENT_NAME=something registry.gitlab.com/acdh-oeaw/shahi/shahi-frontend/master