MediMate

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

MediMate

MediMate is an app to book an appointment with a doctor. It is built as a two part app. This is the frontend part of the app. The back end part of this app can be found here.

🛠 Built With

Tech Stack

Client

• React

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• API Endpoints to login a user
• API Endpoints to book appointments
• Simple User Interface

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 npm start

Setup

Clone this repository to your desired folder:

  git clone git@github.com:mailsg/medimate-frontend.git
  cd medimate-frontend

Install

Install this project with:

  cd medimate-frontend
  npm install

Usage

To run the project, execute the following command:

Please follow the extra procedures below for a great user experience:

  1. npm start

  2. When the app opens, click the log_in button on the navigation panel

  3. If you are a registered user, log_in. If not, click the sign_up button on the top right to register before you log_in with the same credentials.

  4. If you are using the app for the first time, you will have to add doctors using the add doctors form in the navigation panel before accessing any page

  5. From the navigation panel:
   a. add doctors you want
   b. delete doctors you dont want
   c. reserve a doctor
   d. delete a reservation
   e. click on doctor name to see details
   f. log_out

Run tests

To run tests, run the following command:

  npm test

(back to top)

👥 Authors

👤 Charles Andrews

• GitHub: @forloop94
• LinkedIn: LinkedIn

👤 Emmanuel Tofa

• GitHub: @uno36
• LinkedIn: LinkedIn

👤 Sandeep Ghosh

• GitHub: @mailsg
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Booking Fee Payment
• Medical Records Storage
• Online Consultations

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project consider leaving a star to the repository.

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for giving us this opportunity to showcase our skills as a full stack developer. We would also like to thank Murat Korkmaz for providing the wonderful design of the app on Behance. Last but not the least a big thanks to the Open Source ecosystem for providing free to use resources without which the project would not have taken the shape. Thank you all.

(back to top)

📝 License

This project is MIT licensed.

(back to top)