This application is about creating a reservation for an online class with a teacher
This App has the following features:
- User can create an account
- User can signin
- User can view all available teachers
- User can view a specific teacher informations
- User can reserve an online class with a teacher
- User can view all his/her reservations
Ressource URL | Methods | Description |
---|---|---|
/api/v1/users | POST | Signup a new user |
/api/v1/authentications | POST | Sign in a current user |
/api/v1/teachers/ | GET | Get all available teachers |
/api/v1/teachers/:teacher_id | GET | Get a specific teacher informations |
/api/v1/reservations/ | POST | Post a new reservation |
/api/v1/reservations | GET | Get all available reservations |
- Ruby v3.0.2
- Rails v6.1.4
- PostgreSQL
- Bcrypt
- JWT
To get this project up and running locally, you must already have ruby and necessary gems installed on your computer
To get this project set up on your local machine, follow these simple steps:
- Open terminal
- Clone the repository
git@github.com:DeliceLydia/online-class-reservation-apis.git
- Cd in the project
online-class-reservation-apis
- Run
bundle install
- Create database by running
rails db:create
- Install webpacker by running
bundle exec rails webpacker:install
- Run database migration by running
rails db:migrate
- Seed the database by running
rails db:seed
- Start your server
rails server
- Run the app
http://localhost:3000/
rspec --format documentation
Check out here Postman Documentation
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
👤 Delice Lydia
- GitHub: Delice Lydia
- Twitter: Delice
- LinkedIn: Delice Lydia
Give a ⭐️ if you like this project!
Credits goes to the Murat Korkmaz on Behance for the design inspirations.
This project is MIT licensed.