Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olipliche/e-learning-platform
https://github.com/olipliche/e-learning-platform
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/olipliche/e-learning-platform
- Owner: OLIPLICHE
- License: mit
- Created: 2022-01-26T13:04:25.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-08-31T22:23:20.000Z (about 2 years ago)
- Last Synced: 2023-08-14T16:03:21.425Z (over 1 year ago)
- Language: Ruby
- Size: 1.16 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# e-learning platform BACKEND
This project is about creating API end point using Ruby on Rails. The API has courses and enrolment 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](https://guides.rubyonrails.org/getting_started.html)
- [Rswag]https://github.com/rswag/rswag)
### Setup
- ```git clone [email protected]: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](https://github.com/codecaiine/)
- LinkedIn: [Yannick-Noel AKA](https://www.linkedin.com/in/yannick-no%C3%ABl-aka/)
👤 **Mavoungou Paka**
- GitHub: [@OLIPLICHE](https://github.com/OLIPLICHE)
- LinkedIn: [Mavoungou Paka](https://www.linkedin.com/in/olipliche/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/OLIPLICHE/e-learning-platform/issues).
## Show your support
Give a ⭐️ if you like this project!!
## Acknowledgments
- Microverse