🎓 StudentProgress API 📊

StudentProgress is a Spring Boot application for managing and tracking student data, including grades and academic status.
It provides an API for registering, updating, and monitoring student records, calculating averages, and offering real-time insights into student performance.
This helps educational institutions streamline their processes efficiently.

---

✨ Features

• 📌 Register and update student records
• 🧮 Automatically calculate grade averages
• 🌐 RESTful API design for easy integration
• 🔗 HATEOAS support for enhanced API navigation
• 🛠️ Database version control with Flyway

---

🚀 How to Use

1. Clone the repository:

   git clone [email protected]:henriiqueaze/StudentProgress.git
   cd StudentProgress

2. Set up environment variables: Copy the example file and customize it:

   cp .env.example .env

3. Build the application (.jar) with Maven: This step compiles the code and generates the .jar file inside the target/ folder:

   ./mvnw clean package

4. Run the application using Docker Compose:

   docker-compose up --build

5. Access the API documentation (Swagger):

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

---

🔗 API Endpoints

• 🆕 POST /student - Register a new student
• 📄 GET /student - Retrieve student details
• ✏️ PUT /student - Update student information
• ❌ DELETE /student - Remove a student record
• 📊 GET /student/average/{id} - Get student grade average

---

🛠️ Technologies Used

• ☕ Java (Spring Boot)
• 🗄️ MySQL (Database)
• 🏗️ Hibernate (ORM)
• 🔗 HATEOAS (Hypermedia API support)
• 🧪 JUnit (Testing framework)
• 📂 Flyway (Database migrations)
• 🐳 Docker & Docker Compose
• 📑 Swagger (API documentation)

---

📜 License

This project is licensed under the MIT License.
Feel free to use and modify it according to your needs.

---

For contributions or support, please contact me via email at [email protected]
or connect with me on LinkedIn.