MediMate

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • Kanban Board
• 💻 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 backend part of the app. The front end part of this app can be found here. The team members of this project are

• Charles Andrews
• Emmanuel Tofa
• Sandeep Ghosh

🛠 Built With

Tech Stack

Key Features

• API Endpoints to login a user
• API Endpoints to book appointments
• API deployment

(back to top)

🚀 Live Demo

• Live Backend Link
• API Documentation

Kanban Board

• Link to the project kanban board

• 

(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:

 gem install rails

Setup

Clone this repository to your desired folder:

  git clone [email protected]:mailsg/medimate-backend.git
  cd medimate-backend  

Install

Install this project by executing the following commands. Since its an Open API, there is no need to set up any API keys:

  cd medimate-backend

  bundle install

  touch .env
    `Add the following lines to the .env file`
      DB_USERNAME=`Your PostgreSQL username`
      DB_PASSWORD=`Your PostgreSQL password`

  To generate keys when master.key file is missing in the repo:
  
    1. Remove config/master.key and config/credentials.yml.enc if they exist.
    2. Run in the terminal: EDITOR=code rails credentials:edit 
    3. Close the editor that opens.
    4. This command will create a new master.key and credentials.yml.enc if they do not exist.
    5. Run the commands below to create the database
  
    rails db:create
    rails db:migrate
    rails db:seed

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec

(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)