Theophile-Kango / book_appointment_api

The project is about building a Rails api for booking the appointment between patient and doctor

Courses Book the Appointment API

The project is about building a book appointment API that should help patient of a given hospital to book appointment with available doctor

Features

This API is made of four models

• User model
• Appointment model
• Doctor model
• Category model The API has the following endpoints

POST /auth/login

allow user to authenticate and return a token

POST /signup

allows user to create an account

GET /user

returns the user information

PUT /user

allows user to edit their profile

GET /doctors

returns all the doctors

POST /doctors

allows admin to create a doctor

GET doctors/id

returns a specific doctor

PUT /doctors/id

allows admin to edit a doctor

DELETE /doctors/id

allows admin to delete a doctor

GET /appointments

returns the user's appointments information

POST /appointment

allows the user to create the appointment

GET /appointments

returns all the appointments

Built With

• Ruby
• Ruby on rails

Prerequisites

• Get ruby latest version installed
• Get ruby on rails latest version installed
• Get postgresql installed

Setup

• Clone the repository on your local machine
• cd into the folder
• run bundle install
• run rails db:migrate
• run rails server

Install

• Install VSCode or any code editor you like
• Install Ruby(most recent version)
• Install Ruby on rails

Author

👤 Theophile Kango

• Github: @githubhandle
• Twitter: @twitterhandle
• Linkedin: linkedin

🤝 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

• Hat tip to anyone whose code was used
• Inspiration
• etc

📝 License