README.md 2.85 KB
Newer Older
David Trattnig's avatar
David Trattnig committed
1

2
# Engine Clock
David Trattnig's avatar
David Trattnig committed
3

4
<!-- TOC -->
David Trattnig's avatar
David Trattnig committed
5

6
7
8
9
10
11
12
- [Engine Clock](#engine-clock)
    - [Customization](#customization)
    - [Build and deploy for production](#build-and-deploy-for-production)
    - [Development](#development)
        - [Requirements](#requirements)
        - [Getting started](#getting-started)
- [About](#about)
David Trattnig's avatar
David Trattnig committed
13

14
<!-- /TOC -->
David Trattnig's avatar
David Trattnig committed
15

16
Aura Engine Clock is a web application for displaying the studio clock of the [Aura Radio Software Suite](https://gitlab.servus.at/aura/meta).
David Trattnig's avatar
David Trattnig committed
17

18
## Customization
David Trattnig's avatar
David Trattnig committed
19

20
## Build and deploy for production
David Trattnig's avatar
David Trattnig committed
21

22
To create an optimised version of the app run
David Trattnig's avatar
David Trattnig committed
23
24
25
26
27

```bash
npm run build
```

28
## Development
David Trattnig's avatar
David Trattnig committed
29

30
### Requirements
David Trattnig's avatar
David Trattnig committed
31

32
* [Node.js](https://nodejs.org)
David Trattnig's avatar
David Trattnig committed
33

34
### Getting started
David Trattnig's avatar
David Trattnig committed
35

36
Install the NPM requirements
David Trattnig's avatar
David Trattnig committed
37
38

```bash
39
npm install
David Trattnig's avatar
David Trattnig committed
40
41
```

42
Then start the development server using [Rollup](https://rollupjs.org)
David Trattnig's avatar
David Trattnig committed
43
44

```bash
45
./run.sh
David Trattnig's avatar
David Trattnig committed
46
```
David Trattnig's avatar
David Trattnig committed
47

48
49
Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, 
save it, and reload the page to see your changes.
David Trattnig's avatar
David Trattnig committed
50

51
52
By default, the server will only respond to requests from localhost. To allow connections from other computers, 
edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.
David Trattnig's avatar
David Trattnig committed
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# About

Aura Engine Clock is a web application for displaying the studio clock of the [Aura Radio Software Suite](https://gitlab.servus.at/aura/meta).

This project is based on [Svelte](https://svelte.dev/).

[<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-logo.png" width="150" />](https://gitlab.servus.at/aura/meta)

AURA stands for Automated Radio and is a swiss army knife for community radio stations. Beside the Engine it provides Steering (Admin Interface for the radio station), Dashboard (Collaborative scheduling and programme coordination), Tank (Audio uploading, pre-processing and delivery). Read more in the [Aura Meta](https://gitlab.servus.at/aura/meta) repository or on the specific project pages.

| [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-steering.png" width="150" align="left" />](https://gitlab.servus.at/aura/steering)  |  [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-dashboard.png" width="150" align="left" />](https://gitlab.servus.at/aura/dashboard)  |  [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-tank.png" width="150" align="left" />](https://gitlab.servus.at/aura/tank) | [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-engine.png" width="150" align="left" />](https://gitlab.servus.at/aura/engine)  |
|---|---|---|---|
| [Steering](https://gitlab.servus.at/aura/steering)  | [Dashboard](https://gitlab.servus.at/aura/dashboard)  | [Tank](https://gitlab.servus.at/aura/tank)  | [Engine](https://gitlab.servus.at/aura/engine)<br/>[Engine API](https://gitlab.servus.at/aura/engine-api)<br/>[Engine Clock](https://gitlab.servus.at/aura/engine-clock)  |