codecaiine / e-learning-platform

e-learning platform BACKEND

This project is about creating API end point using Ruby on Rails. The API has courses and enrolments endpoints. The API also has authentication and authorization for the user.

Built With

• Ruby on Rails
• Rswag
• Git

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Ruby on Rails
• [Rswag]https://github.com/rswag/rswag)

Setup

• git clone [e-mail]:OLIPLICHE/e-learning-platform.git

• cd e-learning-platform

Running The App

• Run bundle install to install all the necessary gems
• Run rake db:create and rake db:migrate then run rails s
• Go to the browser and type localhost:3000 to see the app

Test

• Run gem install rspec to install Rspec,

• Run rspec spec to run all the test cases, and

• Run rspec spec/name_of_test_file.rb to run test cases individually.

API Documentation

• Used Rswag for the API documentation

Authors

👤 Yannick-Noel Aka

• GitHub: @codecaiine
• LinkedIn: Yannick-Noel AKA

👤 Mavoungou Paka

• GitHub: @OLIPLICHE
• LinkedIn: Mavoungou Paka

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!!

Acknowledgments

• Microverse