This repository contains the narrowcasting application of the Aurora software suite. It is the subscriber that is used by Screen entities. After authenticating using HTTP, the client will connect to the core using SocketIO to listen for incoming commands. It will then execute these commands accordingly. However, if extra information is needed (for example to render a certain poster), the client can make HTTP calls to the core to request this data.
- NodeJS 20.
- A locally running copy of aurora-core.
The backoffice repository should be cloned next to the core repository, so in the folder
../aurora-core. This is necessary to generate the required API client files (installation step 2).
- Run
npm install. - Run
npm run gen-clientto generate the Typescript files required to communicate with the core. - Run
npm run dev. - The application should now be running at http://localhost:8080. You can authenticate a screen on the client by going to th URL https://localhost:8081/?key=KEY_HERE.
Deployment is done using Docker-compose in the core repository. This should work out of the box if you meet the prerequisites.
Copyright © 2023-2024 Study Association GEWIS - Some rights reserved. You can use our software freely within the limits of our license. However, we worked very hard on this project and invested a lot of time in it so we ask you to leave our copyright marks in place when modifying our software. Of course, you are free to add your own.
Aurora uses the AGPL-3.0 license.