albertdavid00 / GymApp-Backend

REST API made using Spring Boot.

GymApp-Backend

Developed using Java 17 and Spring Boot.

About The Project

The purpose of the application is to help the persons that go to the gym regularly, by keeping track of their progress throughout time and by managing their workout routines. The application also targets a social side, by sharing thoughts about people’s workouts.

Business Requirements

1. Users should be able to authenticate/register into the application.
2. Users should be able to manage their profile and view other users.
3. Users should be able to view the available gyms.
4. Users should be able to start a new empty workout.
5. Users should be able to add exercises and sets to an active workout.
6. To find a specific exercise, users should be able to filter through exercises by specifying the name.
7. Users should be able to finish a workout and view details about their workout (with insights about the volume and duration calculated automatically).
8. Users should be able to add comments to workouts they find interesting and manage them.
9. Users should be able to view their favourite gym (calculated based on the number of workouts done there). 10.Admins should be able to add new gyms in the application and manage them.
10. Admins should be able to add new examples of exercises in the application and manage them.

Five Main Features

User

1. Two types of user: ADMIN and USER. The admins are allowed to manage entities (such as exercise, gym etc.) that concern all users, they have full control over the application, while the normal users can make basic operations on the workouts.
2. Represent a way to identify into the application.
3. Hold information such as first name, last name, email, age.

Workout

1. The app revolves around this entity.
2. Used by users to record information about their real-life workout and keep track of their progress.
3. Holds the exercises done by the user during the session and also gives insights about the volume and the duration of the workout.

Exercise

1. Represent examples of physical activities that users can perform in the gym.
2. Hold information like a description of steps to do the exercise correctly, what muscle groups are targeted (ex. Chest, Shoulders, Biceps etc.) and what equipment is required (ex. Barbell, Dumbbell etc.).

Workout-Exercise

1. Represents the relationship between a user’s workout and the exercises they are about to perform during the workout.
2. Holds information about the sets that the user performs for that specific exercise.

Set

1. Holds information about the user’s performance for an exercise, such as the weight, the number of repetitions and the type of the set (warm-up, normal, drop, failure etc.).

Getting Started

Installation

1. Clone the repo

   https://github.com/albertdavid00/GymApp-Backend.git

2. Install Docker Desktop from here.

3. Run MariaDB instance inside a docker container

   docker pull mariadb:10.4
   docker run --name mariadb-gymapp -e MYSQL_ROOT_PASSWORD=mypass -p 3310:3306 -d mariadb:10.4
   
   Create Schema gymapp using MySQL Workbench

4. Run Keycloak instance inside a docker container

   docker pull jboss/keycloak
   docker run -d -p 8081:8080 --name keycloak-gymapp jboss/keycloak
   docker exec keycloak-gymapp /opt/jboss/keycloak/bin/add-user-keycloak.sh -u admin -p admin
   docker restart keycloak-gymapp
   
   Accessing localhost:8081/auth (username: admin, password: admin)
   Add Realm -> GymApp
   Create client -> gym-client
   Add Realm Roles -> ADMIN, USER