This is a simple Student Course Registration WebApi that allows students to view courses and register for them, while instructors can manage student registrations and view student data. The project is built using Ruby On Rails, ActiveRecord and mysql2.
- CRUD operations for students and their gender.
- CRUD operations for Courses and their Department.
- Ruby
- Ruby on rails
- mysql2 database
- Swagger
To get started with this project, follow these steps:
- Clone the repository to your local machine.
git clone https://github.com/seifhassan89/StudentCourses
- Install Ruby and Ruby on Rails if you haven't already
gem install rails -v 5.0.1
- Run bundle install to install all required gems.
bundle install
1.to create the database run:
db:create
2.to run the database migrations run:
db:migrate
- Here is command to run your application:
rails s
You should now be able to access the application at http://localhost:3000. As you should now be able to access the Swagger Documentation at http://localhost:3000/api-docs/index.html Or http://localhost:3000/Api/#.
The API endpoints can be tested using a tool such as Postman. The following endpoints are available:
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new feature branch.
- Make your changes.
- Create a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.