ilyassatlassi/microverse-final-capstone-project

Microverse final capstone project

Reserve Me A Doctor

📗 Table of Contents

• 📖 About the Project
  • Kanban board
  • 🛠 Built With
    • Tech Stack
  • Key Features
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • API Documentation
  • Run Tests
• 🚀 Live Demo
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

Reserve Me A Doctor

This is the backend for a web application that allows users to book appointments with doctors. The frontend repository can be found here.

Project kanban board

Our group consists of 5 members. We used this kanban board to split tasks and track progress. This is the screenshot of the initial state of the kanban board.

🛠 Built With

Tech Stack

• Ruby on Rails
• Postgres

Key Features

• User management (signup and login)
• Reservations management (add and remove)
• Doctors management (add and remove)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Ruby environment installed
• Postgres database installed

Setup

Clone this repository to your desired folder:

cd my-folder
git clone https://github.com/preciousbetine/microverse-final-capstone-project.git

Install

Run bundle install to install all the required dependencies.

Usage

To run the project:

Create the database by running the following command:

rails db:create

Load the database schema with this command:

rails db:schema:load

Seed the database with the following command:

rails db:seed

Start the server by running the following command:

rails server

API Documentation

The API documentation is available at /api-docs. Live here.

Run tests

The RSpec testing library was used to write tests. To run them, simply run the RSpec binary:

rspec

(back to top)

🚀 Live Demo

The project was hosted on render and is live here.

(back to top)

👥 Authors

👤 David-Lanzz

• GitHub: @david-lanzz
• Twitter: @lanzzdavid
• LinkedIn: david-lanzz

👤 Sabi Mantock

• GitHub: @sabimantock
• Twitter: @iamsabimantock
• LinkedIn: sabi-mantock

👤 Precious Betine

• GitHub: @preciousbetine
• Twitter: @preciousbetine
• LinkedIn: preciousbetine

👤 Ilyass Atlassi

• GitHub: @ilyassatlassi
• Twitter: @ilyass_atlassi
• LinkedIn: ilyassatlassi

👤 Fahim Khan:

• GitHub: @Fahim-Khan-P
• LinkedIn: fahimkhan-p

(back to top)

🔭 Future Features

• Verify email addresses
• Reset user passwords
• Update user information

(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 please give it a ⭐️.

(back to top)

🙏 Acknowledgments

We would like to thank Murat Korkmaz on Behance for the template we used for the frontend design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)