gitlab.rlp.net will be temporarily unavailable for maintenance reasons on 2021-01-15 21:00 - 23:00

gitlab.rlp.net will be temporarily unavailable for maintenance reasons on 2021-01-15 21:00 - 23:00

README.md 2.01 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

A. Koch's avatar
A. Koch committed
4
# Motion Bank Systems Frontend
5

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

Anton Koch's avatar
initial  
Anton Koch committed
8 9


Anton Koch's avatar
Anton Koch committed
10
## Setup
Anton's avatar
Anton committed
11

Anton's avatar
Anton committed
12 13
Clone repo, then run:

Anton's avatar
Anton committed
14
```shell
Anton's avatar
Anton committed
15 16
git submodule init
git submodule update
A. Koch's avatar
A. Koch committed
17
npm install
Anton's avatar
Anton committed
18 19
```

Anton Koch's avatar
Anton Koch committed
20 21 22
## Run

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

Anton's avatar
Anton committed
24 25 26 27
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
28

Anton Koch's avatar
Anton Koch committed
29
### Standalone server
30

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

Anton Koch's avatar
Anton Koch committed
35
## Build
36

Anton Koch's avatar
Anton Koch committed
37
To remove any prior build artifacts run `npm run clean`.
38 39

```shell
Anton Koch's avatar
Anton Koch committed
40 41
npm run build
```
42

Anton Koch's avatar
Anton Koch committed
43
### Customise
Anton Koch's avatar
initial  
Anton Koch committed
44

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

Anton Koch's avatar
initial  
Anton Koch committed
47
```shell
Anton Koch's avatar
Anton Koch committed
48
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
49 50
```

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

A. Koch's avatar
A. Koch committed
53
## Development
Anton's avatar
Anton committed
54

Anton's avatar
Anton committed
55 56
Start a development server with automatic reload on
localhost at port 8080.
57

Anton's avatar
Anton committed
58
```shell
A. Koch's avatar
A. Koch committed
59
npm run dev
Anton's avatar
Anton committed
60
```
Anton Koch's avatar
initial  
Anton Koch committed
61

Anton Koch's avatar
Anton Koch committed
62 63
### Changelog

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

67 68
## Docker

Anton's avatar
Anton committed
69 70
The recommended way of deployment are our prebuilt
docker images.
71

Anton's avatar
Anton committed
72 73 74 75 76
[![](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

Christian Hansen's avatar
Christian Hansen committed
77
* Stable: `motionbank/systems-frontend:release_1_2`
Anton's avatar
Anton committed
78 79 80 81 82 83 84
* Staging (beta): `motionbank/systems-frontend:staging`
* Experimental: `motionbank/systems-frontend:experimental`

### Configuration

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

A. Koch's avatar
A. Koch committed
86

Anton Koch's avatar
initial  
Anton Koch committed
87 88
## License

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