📗 Table of Contents

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

📖 [Book an Appointment]

Book an Appointment is Final Capstone Project based on an app to book an appointment with a doctor. This is the back-end which was connected to this front-end repo.

🛠 Built With

Tech Stack

Client

• React

Server

• Ruby on Rails

Database

• PostgreSQL

API Documentation

API-Documentation

Key Features

Here the main goal of building this web application is to have a deeper understanding of how Ruby on Rails can make development of applications easy together with react

• [Create associations between different models involved]
• [fetch Api with react and redux]
• [Build api endpoints]

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• linters.yml and tests.yml files inside the .github folder
• .rubocop.yml file
• Gemfile
• Install rails and required gems

Setup

Clone this repository to your desired folder:

1- Navigate to the button on the top right green "code" button.

2- In the drop down menu choose "Download Zip" or clone it using git using the following command.

3- After extracting the files, you'll have my project on your local machine.

Install

Install this project with:

• Run bundle install

Usage

To run the project, execute the following command:

run: rails db:create db:migrate db:seed

Run tests

To run tests, run the following command:

run: Rspec

(back to top)

👥 Authors

👤 Abubakar Ummar

• GitHub: @Haywayaheadshot
• LinkedIn: @Abubakar Ummar

👤 Abdul Nganje

• GitHub: @Nganje
• Twitter: @asnganje
• LinkedIn: @Nganje

👤 Mohamed Eldeeb

• GitHub: @Mohammed
• Twitter: @El_Deeb
• LinkedIn: @Mohammed Eldeeb

👤 Kelvin Benjamin

• GitHub: @Kelvin-Ben
• Twitter: @kevoyout144
• LinkedIn: @Kelvin-Ben

(back to top)

🔭 Future Features

We will create a React and Ruby on Rails application that allows the user to:

• Register and login, so that the data is private to them
• User is able to book an apointmwnt with a specific doctor
• Able to use other services

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Anyone who finds this project interesting is welcome to give it a star.

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for the opportunity

(back to top)

❓ FAQ (OPTIONAL)

• [How do i run the project in my local machine?]

  • [You need to clone the project in your local environment through the terminal]

• [What database are you using for this project?]

  • [POSTGRESQL]

(back to top)

📝 License

This project is MIT licensed.

(back to top)