oovillagran / final-capstone-back-end

This is the final capstone for the full stack web development program in Microverse.

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

📜 Kanban Board

• visit our kanban board
• Initial kanban board view
• We are a group of five people who collaborated in the entire project

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

final-capstone-back-end's Issues

Implement Reducer to Call Appointments API [3pt]

• Create a appointments component.
• Implement reducer and redux to call appointments.

Create 404 Not Found Page [1pt]

• Create 404 Not Found Page.

Set up React Router [0.5pt]

Remember to:

• Set up front-end routing.

React project setup [1pt]

• Setup repository and use correct gitflow
• Configure linters
• Create a Professional README

Final Capstone: Kanban Board PR

We are 5 in total: @oovillagran, @Mylo16 , @kkolade , @rashedarman and I @federicaulzurrun

Here is the link to our GitHub Project

For this part of the project we:

• Set up the Kanban Board.
• Added Fron-End and Back-End labels to be more organized.
• Divided us into Front-end and Back-end
• Assigned the task as equal as possible having the time points as reference

Here are the screenshots

Create "Delete Doctors" Page [2pt]

• Make the "Delete Item" link in the navigation panel lead to a list of Doctors with name and "Delete" button.
• Implement the "Delete" button functionality to mark doctors as removed.

[2.5Xpt] - Create test for all the Models and Requests

Remember to :

• Write unit and integration tests.

Setup Redux with Redux Tookit [0.25pt]

• Setup Redux with Redux Toolkit.

Create a Navigation Panel [1.5pt]

• In the navigation panel, the user can see links to
  • Doctors
  • "Book an appointment" form (Username is autofilled.)
  • My appointments.
  • Add doctor
  • Delete doctor

[5Xpt] - Generate Models based on the ERD

Remember to :

• Generate the models
• Implement associations and relationship
• Create migrations. (Create tables)
• Create validations
• Create a Test for those validations
• Add Cancancan

Design Home Page [2pt]

• Display a list of doctors.
• Make the list items clickable, leading to the details page.

[3Xpt] - Generate API documentation

Remember to:

• Create an API documentation that provides information for the utilization of the API.
• Implement the Rswag gem.

[3.5Xpt] - Create ERD

Remember to:

• Create it using any online tool
• Explain the diagram to the rest of the group

[1.5 Xpt] N+1 queries in all of the requests

Remember to :

• Make sure there are no N+1 queries happening.

[1.5Xpt] - Set Routes

Remember to:

• Create the navbar
• Set the routers/routes for the navigation links

Create Splash Screen [2pt]

• Make a splash screen at the start of the app, where the user can sign up or sign in

[1.5 Xpt] Set a Login and Registration page

Remember to:

• Add the necessary config and validations.
• Do not add any style.

Create "Add Doctor" Form [2pt]

• Create a form for adding a new doctors.
• Make the "Add Doctor" link in the navigation panel lead to this form.
• Implement form submission and validation.

Make Sure "Add item" and "Delete item" Links Accessible Only by Admins [1pt]

• Make sure that the "Add item" and "Delete item" links are accessible only by users who are admins.

Create User, Clinics and Doctors Reducers [3pt]

[4Xpt] - Generate API controllers

Remember to :

• Generate API
• Create methods for create, read, update and delete.

[1xpt] - Initialize Back-end project

Remember to:

• Initialize RoR app
• Use git-flow
• Set up PostgreSQL as the default database
• Add linters
• Add Rspec
• Add Devise gem

Create "Book an Appointment" Page [2pt]

• Create a page for reserving an appointment.
• Provide inputs for date and clinic (autofill username and selected item).
• To reserve an appointment, the user has to select a date and clinic.

Implement Reducer to Call appointment/details API [3pt]

• Create a basic card structure to call the API without design
• Implement Reducer to call the API "appointment details"

Create Appointments Page [2pt]

• When the user clicks the "My appointments" link in the navigation panel they can see a list of their appointments (with information about doctor's name, date, clinic)

Design Details Page [2pt]

• Create a details page for the selected item.
• Display doctors details.
• Implement the "Appointment" button functionality.