Commit ba9c44e0 authored by mrodzis's avatar mrodzis 🌿
Browse files

docs(readme): add prerequisites

The former README lacked a description of prerequisites which has been fixed by this commit.

cf. #9
parent 5d88dba2
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.0.1] - 2020-05-14
### Added
- This CHANGELOG file
# Emo Viewer (viewer)
Viewer for the modular framework to present digital editions
Viewer for the modular framework to present digital editions.
Demo: https://subugoe.pages.gwdg.de/emo/Qviewer/
## Install the dependencies
## Getting Started
### Prerequisites
To get the EMo Viewer up and running you should have the following software installed:
* npm
* vue-cli (globally installed)
* vue-cli-service-global (globally installed)
For using the development mode you also need
* quasar-cli (globally installed)
To get all dependencies via `npm`, simply run
```bash
npm install -g @vue/cli @vue/cli-service-global @quasar/cli
```
### Installing
### Get the Dependencies
```bash
npm install
```
### Start the app in development mode (hot-code reloading, error reporting, etc.)
### Start the App in Development Mode (Hot-Code Reloading, Error Reporting, etc.)
```bash
quasar dev
```
### Lint the files
### Lint the Files
```bash
npm run lint
```
### Build the app for production
### Build the App for Production
```bash
quasar build
```
### Customize the configuration
### Customize the Configuration
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
## Authors
See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment