Code Monkey home page Code Monkey logo

pearlthoughts-assignment's Introduction

Out-Patient Appointment System API

The Out-Patient Appointment System API is a Ruby on Rails application designed to facilitate the booking of appointments with doctors who practice on a weekly schedule. This README provides an overview of the API and explains how to interact with its endpoints.

Table of Contents

Prerequisites

Before using the API, ensure you have the following installed:

  • Ruby
  • Ruby on Rails
  • SQLite or any other database supported by Rails

Installation

  1. Clone the repository:

    git clone <repository_url>
  2. Navigate into the project directory:

    cd Doctor-Appointment
  3. Install dependencies:

    bundle install
  4. Set up the database:

    rails db:migrate

Usage

Doctors Listing

To retrieve a list of all doctors:

GET /doctors

Doctor Detail Page

To retrieve details of a specific doctor:

GET /doctors/:id

Availability

To retrieve availabilities for a specific doctor on a given date:

GET /doctors/:doctor_id/availabilities?date=<date>

Appointment Booking

To book an appointment with a specific doctor:

POST /doctors/:doctor_id/appointments

Request Body: { "date": "YYYY-MM-DD", "time": "HH:MM:SS", "patient_name": "Patient Name" }

Screenshot from 2024-04-19 11-05-50 Screenshot from 2024-04-19 11-06-04 Screenshot from 2024-04-19 11-06-57 Screenshot from 2024-04-19 11-06-25

pearlthoughts-assignment's People

Contributors

malavi1 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.