Skip to content

YUSU-Dev/roses-live

Roses Live

Every year York SU plays against Lancaster SU in Europe's biggest varsity, 2025 marks 60 years since the first boat race of Roses. This repo contains all the code for the front end for RosesLive, this works in conjunction with our internal tools and a dedicated media platform to allow our media partners to report on the fixtures over the weekend.

Technologies used

Setup

Make sure to install the dependencies:

npm install

Duplicate the .env.example to .env

cp .env.example .env

Development Server

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Check out the deployment documentation for more information.

Testing

To run tests within the application, run:

npm run test:unit

Tests utilise X. Additional tests should be added when new business logic is added.

Security

If you've found a vulnerability, we want to know so that we can fix it. Our security policy tells you how to do this.

License

Copyright © 2024 University of York Students' Union

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the License.