Kopie van https://gitlab.com/studieverenigingvia/ict/centurion met een paar aanpassingen
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
centurion/README.md

23 lines
725 B

CENTURION
=========
## Introduction
The projects consists of two projects, a frontend written in React, and a backend written in Typescript (Node). Both communicate with a websocket.
## Setup
1. Download the various song files and place them in `frontend/public/songs/`. Easiest way to do this is to get them from production (E.g. `https://centurion.svia.nl/songs/centurion.m4a`)
2. Run `npm i` in the root directory, frontend, and backend.
3. Prepare the pre-commit hooks by running `npm run prepare`.
ESLint is used for linting, Prettier for formatting. Currently, there are no tests. Tread carefully.
## Starting
* Start the frontend by running `npm run start` in the frontend directory.
* Idem for the backend.