Home

Introduction

Welcome to the TuitionToAll API Documentation. This API serves as the backend for the TuitionToAll project, a centralized Learning Management System (LMS) that connects institutes, teachers, and students. The API provides authentication, user management, and course-related functionalities.

Tech Stack

• Spring Boot – Backend framework
• MySQL – Database
• Hibernate – ORM for data persistence
• Spring Security & JWT – Authentication & authorization
• RESTful APIs – For seamless client-server communication

Features

• User Registration (Institute, Teacher, Student)
• Secure Authentication & Authorization (JWT-based)
• User Login & Role-based access
• Course Management (Upcoming feature)

API Usage

To use this API, you need to send HTTP requests to the specified endpoints. Each request should include necessary headers, request bodies, and authentication tokens (where required). Detailed API endpoints and request/response examples are available in the documentation.

Getting Started

1. Clone the repository and set up the project.
2. Configure the database connection in application.properties.
3. Run the application using:

   mvn spring-boot:run

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

Authentication

• The API uses JWT tokens for authentication.
• Users must log in to obtain a token.
• Include the token in the Authorization header for protected routes:

  Authorization: Bearer YOUR_JWT_TOKEN
  

Next Steps

• User Registration
• User Login

For any issues, feel free to create a GitHub issue or contribute to the repository!