This is a Rails API application designed to handle student registration for universities. It provides endpoints for creating, updating, and retrieving student registration data. Alternative API documentation on bumb.sh click link below https://bump.sh/decryptcoder/doc/spmb-del.
- Student Registration: Students can register for the university by providing necessary details.
- Course Enrollment: Registered students can enroll in available courses.
- Student Profiles: Each student has a profile where they can update their details and view their enrolled courses.
- Course Management: Admin users can create, update, and delete courses.
- JWT and Bearer Authentication: The API uses JWT (JSON Web Tokens) for authentication, ensuring secure access to the endpoints.
- API Documentation: The API endpoints are documented using Swagger UI, providing an interactive interface for exploring the API.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Ruby version 3.0.0
- Rails version 7.1.3
- PostgreSQL or Sqlite3
- Clone the repository:
- Change into the directory
- Install the dependencies
- Setup the database or run migration
- Start the server
The application is now running at http://localhost:3000.
The API documentation is available at http://localhost:3000/api-docs. The documentation provides a detailed description of each endpoint, including the required parameters and the response format. It also provides an interactive interface for making requests to the API.
Run the test suite using the following command:
- rails test:controllers
- rails test:models
We welcome contributions to this project! Please read our Contributing Guide for more information.
This project is licensed under the MIT License - see the LICENSE file for details.
