Skip to content

Magenta-Mause/Medals-Frontend

Repository files navigation

Medals

Train smarter. Track better. Win medals.

License of medals Website Status

Medals-Frontend - the frontend of Medals.

Table of contents

Medals

Medals is an application to administer athletes for the Deutsche Sportabzeichen. Trainers can administer their athletes, track the performances for different disciplines, add/remove swimming certificates, see wether the athlete is eligible to receive a Deutsche Sportabzeichen. Athletes can see their own performances, wether they have a valid swimming certificate and if they are eligible for a Deutsche Sportabzeichen, if not what they need to do to be eligible.

Setup

Requirements

  • Node v.22.3.0
  • npm v.10.8.1
  • JDK21
  • git v.2.45.1.windows.1

As of writing this those are the versions used to develop the application. Other software versions might work but are not tested.

Frontend Setup

  1. git clone https://github.com/Magenta-Mause/Medals-Frontend.git
  2. npm i
  3. npm run dev

The frontend should now be accessible on http://localhost:5173.

Backend Setup

  1. git clone https://github.com/Magenta-Mause/Medals-Backend.git
  2. change the email value of app.admin.admins to your email address in src/main/resources/application.yml
  3. mvn spring-boot:run -Dspring-boot.run.profiles=local

The backend should now be accessible on http://localhost:8080.

Deployment

Official Deployment

Medals has an official deployment that you can find with the following url: https://stratssync.com/

You can only use Medals if you are invited either by an administrator or a trainer. If that is not the case for you, but you still want to use the application you either need to deploy it locally for you or make a custom deployment. For the local deployment regard the Medals-Deployment documentation.

Custom Deployment

To create your own deployment you need to change the environment variables in the .env-file to your respective backend url. After that you have to run npm run build:image to create the docker image locally. For further information on how to deploy your own full deployment regard the Medals-Deployment documentation.

Published Docker Images

On every push to main or if the Build Frontend workflow is dispatched manually two Docker images are published. The images can be found on Docker Hub.

The latest image is used for the official deployment while the image with the local tag can be used for local deployments.

About

The medals frontend

Resources

License

Stars

Watchers

Forks

Contributors