README.md

EasyClinic API App

📗 Table of Contents

• EasyClinic
• 📗 Table of Contents
• 📖 EasyClinic app
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo & preview
    • API Documentation
    • Live Demo
  • 📜 Kanban Board
    • Kanban Board
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 EasyClinic API app

EasyClinic is a back-end application, for our Final Capstone Project. It is based on an app to book an appointment with a doctor from a wide health network.

EasyClinic front-end application is available here.

🛠 Built With

Tech Stack

• Ruby
• PostgreSQL

Key Features

• Use of Ruby on Rails framework.
• Back-end application
• Use of Kanban board

(back to top)

🚀 Live Demo & preview

API Documentation(#api-documentation-)

Here you can see the API Documentation, in render.

API URL

You can use this URL address to consump data from our API using localy or using the URL provided by render https://rails-xdb0.onrender.com

💻 Getting Started

Follow these steps in order to run ruby code.

Prerequisites

First, you need to ensure that you have Rails and Ruby installed on your computer.

Setup

It varies depending on your operating system so here are some links to help you install it on Windows and on Ubuntu.

For MacOS run the following commands

  brew install rbenv ruby-build
  # Add rbenv to bash so that it loads every time you open a terminal
  echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
  source ~/.bash_profile

  # Install Ruby
  rbenv install 3.0.1
  rbenv global 3.0.1
  ruby -v

This example shows how to install Ruby 3.0.1 which was the latest version in April 2021, but you can check to see if there is a newer version here. Iy is also assumed that you have homebrew already installed on your Mac.

Usage

Before running the project, make sure you have Ruby and Rails installed on your system. You can refer to the official Ruby on Rails installation guide for instructions on how to install them. Once you have ruby installed, clone this repository

First navigate to the project directory in your terminal:

  cd your-project-directory

Then install the required gems by running in the terminal:

  bundle install

Create the database by running:

  rails db:create

Run the database migrations to set up the database schema:

  rails db:migrate

Optionally, you can seed the database with initial data (if the project provides seed data) by running:

  rails db:seed

Start the Rails server:

  rails server

To see all API Endpoints available, in your preferred browser, navigate to:

  https://rails-xdb0.onrender.com/api-docs/index.html

Run tests

To run tests, run the following command in the terminal:

  rspec

👥 Authors

👤 Federica Ulzurrun

• GitHub: @federicaulzurrun
• Twitter: @ulzurrunfede
• LinkedIn: Federica Ulzurrun

👤 Rashed Arman

• GitHub: @rashedarman
• Twitter: @rashedarman21
• LinkedIn: @rashedarman

👤 Kola Kolade

• GitHub: @kkolade
• Twitter: @kola_kolade

👤 Eric Antwi

• GitHub: @Mylo16
• Twitter: @EricAntwi384
• LinkedIn: ericopokuantwi

👤 Oscar Villagran

• GitHub: @oovillagran
• Twitter: @oovillagran
• LinkedIn: Oscar Villagran

(back to top)

🔭 Future Features

The following are the future features that will be added to the project.

• Add images and videos section.
• Add payment options.

(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 you can give us a hand by recommending either one of us to potential employers! 😉🤝

(back to top)

🙏 Acknowledgments

We would like to thank those who have motivated us to keep on fighting despite how tough the journey may become.

(back to top)

📝 License

This project is MIT licensed.

(back to top)