🌱 SpringFit

A modern REST API for managing gyms, students, and workouts with Spring Boot.

---

📃 About  •   🛠️ Technologies  •   ✨ Features  •   🗄️ Database Diagram  •   🚀 Getting Started  •   📖 API Documentation

---

📃 About

SpringFit is a REST API for gym management built with Spring Boot and Spring Security. It allows you to register students, create personalized workouts, manage exercises by muscle group, and record physical assessments. The API features JWT authentication, role-based access control, and interactive documentation powered by Swagger.

---

🛠️ Technologies

• ☕ Java 17 — Main programming language.
• 🌱 Spring Boot — Framework for building modern Java applications.
• 🔐 Spring Security — Authentication and access control.
• 🗃️ Spring Data JPA — Data access abstraction with Hibernate.
• 📦 Maven — Dependency management and project build automation.
• 🐬 MySQL — Relational database used in production.
• 🐳 Docker — Database containerization for a reproducible environment.
• 📖 SpringDoc OpenAPI — Interactive API documentation via Swagger UI.
• 🔑 JJWT — JWT token generation and validation.
• 🏗️ Lombok — Boilerplate reduction through code generation.
• ✅ Bean Validation — Input data validation.

---

✨ Features

• 🔐 JWT authentication (register and login)
• 👥 Role-based access control (ADMIN and STUDENT)
• 🎓 Student registration and removal
• 🏋️ Personalized workout creation per student
• 💪 Exercise management by muscle group
• 📊 Physical assessment registration and retrieval
• 📄 Paginated assessment listing
• 🛡️ Students can only view their own physical assessment
• 📖 Interactive documentation with Swagger UI

---

🗄️ Database Diagram

erDiagram
    student {
        uuid id PK
        string name
        string email
        string password
        string phone
        date birth_date
        int assessment_id FK
        datetime created_at
    }
    physical_assessment {
        uuid id PK
        float weight
        float height
        float body_fat_percentage
        float bmi
        datetime created_at
        datetime updated_at
    }
    workout {
        uuid id PK
        string name
        string objective
        string description
        uuid student_id FK
        datetime created_at
        datetime updated_at
    }
    exercise {
        uuid id PK
        string name
        string muscle_group
        string equipment
        string description
        string difficulty_level
        datetime created_at
    }
    workout_exercise {
        int workout_id PK, FK
        int exercise_id PK, FK
    }
    student ||--|| physical_assessment : "has"
    student ||--o{ workout : "has"
    workout ||--o{ workout_exercise : "contains"
    exercise ||--o{ workout_exercise : "used in"

Loading

---

🚀 Getting Started

📋 Prerequisites

• ☕ Java 17+
• 📦 Maven
• 🐳 Docker

🔧 Installation

1. Clone the repository:

   git clone https://github.com/joschonarth/spring-fit.git

2. Navigate to the project folder:

   cd spring-fit

3. Set up environment variables in src/main/resources/application.yml:

   datasource:
     username: ${DB_USERNAME:docker}
     password: ${DB_PASSWORD:docker}
   
   jwt:
     key: ${JWT_KEY:your_secret_key}
     expiration: ${JWT_EXPIRATION:900000}

   💡 Values after : are the defaults used when the environment variable is not set.

🐳 Database

Start the MySQL container with Docker:

docker compose up -d

🗄️ Alternative Database (H2)

If you prefer to use the in-memory H2 database without Docker, comment out the MySQL block and uncomment the H2 block in src/main/resources/application.yml:

# H2 In-Memory Database
datasource:
  url: jdbc:h2:mem:testdb
  driver-class-name: org.h2.Driver
  username: sa
  password:
h2:
  console:
    enabled: true
    path: /h2-console

With H2 enabled, the console will be available at http://localhost:8080/h2-console.

▶️ Running

Start the application with Maven:

./mvnw spring-boot:run

The API will be available at http://localhost:8080.

---

📖 API Documentation

With the application running, access the interactive documentation generated by Swagger UI:

http://localhost:8080/swagger-ui/index.html

💡 To test protected endpoints, click Authorize and provide the JWT token obtained at login with the Bearer prefix.

---

⭐ Support this Project

If you liked this project, leave a ⭐ on GitHub — it means a lot!

---

Made with ♥ by João Otávio Schonarth