README.md 2.31 KB
Newer Older
A. Koch's avatar
A. Koch committed
1 2
[comment]: # (ACHTUNG! This is an autogenerated file and will be automatically overwritten)
[comment]: # (To edit its contents please refer to the project dir '.readme')
Anton Koch's avatar
initial  
Anton Koch committed
3

4
# Motion Bank Systems Frontend
5

6
> Combined frontend project for Motion Bank web services
Anton's avatar
Anton committed
7

8
[![Docker Pulls](https://img.shields.io/docker/pulls/motionbank/systems-frontend?style=flat)](https://hub.docker.com/r/motionbank/systems-frontend)
Anton Koch's avatar
initial  
Anton Koch committed
9 10


anton's avatar
anton committed
11 12
[![motion-bank-docker](https://circleci.com/gh/motion-bank-docker/systems-frontend.svg?style=svg)](https://app.circleci.com/pipelines/github/motion-bank-docker/systems-frontend)

Anton Koch's avatar
Anton Koch committed
13
## Setup
Anton's avatar
Anton committed
14

Anton's avatar
Anton committed
15 16
Clone repo, then run:

Anton's avatar
Anton committed
17
```shell
Anton's avatar
Anton committed
18 19
git submodule init
git submodule update
A. Koch's avatar
A. Koch committed
20
npm install
Anton's avatar
Anton committed
21 22
```

Anton Koch's avatar
Anton Koch committed
23 24 25
## Run

### Third-party webserver (recommended)
A. Koch's avatar
A. Koch committed
26

Anton's avatar
Anton committed
27 28 29 30
Point your webserver config to the ``dist/spa-mat``
directory. Configure your webserver to serve
``index.html`` with a 200 status code instead of a
404 error page.
A. Koch's avatar
A. Koch committed
31

Anton Koch's avatar
Anton Koch committed
32
### Standalone server
33

Anton's avatar
Anton committed
34 35 36
Execute ``npm start`` to start the built-in webserver.
Control server address through ``HOST`` and ``PORT``
env variables.
37

Anton Koch's avatar
Anton Koch committed
38
## Build
39

Anton Koch's avatar
Anton Koch committed
40
To remove any prior build artifacts run `npm run clean`.
41 42

```shell
Anton Koch's avatar
Anton Koch committed
43 44
npm run build
```
45

Anton Koch's avatar
Anton Koch committed
46
### Customise
Anton Koch's avatar
initial  
Anton Koch committed
47

Anton Koch's avatar
Anton Koch committed
48
In order to customize the build, use these env vars:
A. Koch's avatar
A. Koch committed
49

Anton Koch's avatar
initial  
Anton Koch committed
50
```shell
Anton Koch's avatar
Anton Koch committed
51
API_HOST=http://localhost:3030 STREAMER_HOST=http://localhost:1234 npm run dev  # (or npm run build)
Anton Koch's avatar
initial  
Anton Koch committed
52 53
```

Anton Koch's avatar
Anton Koch committed
54 55
For the available variables see `quasar.conf.js`.

A. Koch's avatar
A. Koch committed
56
## Development
Anton's avatar
Anton committed
57

Anton's avatar
Anton committed
58 59
Start a development server with automatic reload on
localhost at port 8080.
60

Anton's avatar
Anton committed
61
```shell
A. Koch's avatar
A. Koch committed
62
npm run dev
Anton's avatar
Anton committed
63
```
Anton Koch's avatar
initial  
Anton Koch committed
64

Anton Koch's avatar
Anton Koch committed
65 66
### Changelog

Anton's avatar
Anton committed
67 68
Development is tracked in
[CHANGELOG.md](https://gitlab.rlp.net/motionbank/systems-frontend/blob/master/CHANGELOG.md).
Anton Koch's avatar
Anton Koch committed
69

70 71
## Docker

Anton's avatar
Anton committed
72 73
The recommended way of deployment are our prebuilt
docker images.
74

Anton's avatar
Anton committed
75 76 77 78 79
[![](https://images.microbadger.com/badges/image/motionbank/systems-frontend.svg)](https://microbadger.com/images/motionbank/systems-frontend
"Get your own image badge on microbadger.com")

### Versions

Anton's avatar
Anton committed
80
* Stable: `motionbank/systems-frontend:release_1_3`
Anton's avatar
Anton committed
81
* Staging (beta): `motionbank/systems-frontend:staging`
Anton's avatar
Anton committed
82
* Experimental: `motionbank/systems-frontend:dev`
Anton's avatar
Anton committed
83 84 85 86 87

### Configuration

The image is not configurable.
The application listens on port `3030`.
88

A. Koch's avatar
A. Koch committed
89

Anton Koch's avatar
initial  
Anton Koch committed
90 91
## License

Anton's avatar
Anton committed
92
:copyright: 2020 Mainz University of Applied Sciences (Motion Bank Project) – 
93
Released under the [MIT](https://github.com/motionbank-js/systems-frontend/blob/master/LICENSE) license
A. Koch's avatar
A. Koch committed
94