0sugo/appointment_booker_backend

Doctor_appointment_reservation_back_end

📗 Table of Contents

• Doctor_appointment_reservation_back_end
• 📗 Table of Contents
• 📖 [Appointment_booker_back_end]
  • Link to the front-end repo
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐ Show your support
  • 🙏Acknowledgments
  • 📝 License

📖 [Appointment_booker_back_end]

[Appointment_booker_back_end] is a backend rails api that provides service to the front-end react app to fetch data for doctors appointment reservation.

Link to the front-end repo

🛠 Built With

Tech Stack

Ruby on Rails

• https://rubyonrails.org/

Key Features

• [Render available doctors]
• [Add doctors]
• [Delete doctors]
• [Reserve an appointment with a specific doctor]
• [View all appointments for a specific user]
• [Delete an appointment with a specific doctor]

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Install Ruby
• Install Rails
• Install Postgresql

Setup

Clone this repository to your desired folder:

  git clone https://github.com/0sugo/appointment_booker_backend.git
  cd appointment_booker_backend

Install

Install this project with:

  cd appointment_booker_backend
  bundle install

  gem install --no-document rubocop -v '>= 1.0, < 2.0'

Usage

To run the project, execute the following command:

  rails db:create
  rails db:migrate
  rails db:seed
  rails server -p 4000

To view api documentation on the project, execute the following command when server is running:

  http://localhost:4000/api-docs

Run tests

To run tests, run the following command:

  rspec spec

👥 Authors

👤 Micheal Oguntayo

• GitHub: @oguntayomicheal
• Twitter: @OguntayoMicheal
• LinkedIn: @OguntayoMicheal

👤 Ubda Nam

• GitHub: @UbdaNam
• LinkedIn: Abdurahim M.

👤 JOSECK OSUGO

• GitHub: 0sugo
• Twitter: @0sugo5
• LinkedIn: Joseck Osugo

🔭 Future Features

• [] [Delete functionality only for admins ]
• [] [Removing dates and sessions that have been booked already ]

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

⭐ Show your support

If you like this project please show support by staring ⭐️.

🙏Acknowledgments

• We would like to thank Microverse for providing adequate learning material and a safe learning environment.
• We would like to extend our sincerest gratitude for Murat Korkmaz for this beautiful design.

📝 License

This project is MIT licensed.

(back to top)