Code Monkey home page Code Monkey logo

final-capstone-back-end's Introduction

Reserve Me A Doctor

📗 Table of Contents

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

  • The ability to sign-up a patient
  • The ability to add an appointment
  • The ability to add a doctor

💻 Getting Started

Prerequisites

In order to run this project you need:

  • Install Ruby
  • Install Rails
  • Install Posgresql

Setup

Clone this repository to your desired folder:

git clone https://github.com/AbdelazizSoliman/final-capastone-front-end

cd final-capastone-front-end

Install

Install this project with these commands:

cd final-capastone-front-end
bundle install
rails db:create
rails db:migrate
rails db:seed

Usage

To run the project execute the following command:

rails s

Tests

To run the tests for models and requests, execute the following command:

rspec ./spec/models
rspec ./spec/requests/api/v1

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 

Under deployment.

(back to top)

👥 Authors

👤 David

👤 Soliman

👤 Phelelani

👤 Otmanee

👤 Henry:

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

final-capstone-back-end's People

Contributors

abdelazizsoliman avatar katended avatar odongo006 avatar otmaneechchafyky avatar techmoves avatar

Watchers

avatar

Forkers

otmaneechchafyky

final-capstone-back-end's Issues

[2.0Pt] Delete item (7)

When the user clicks the "Delete item" link in the navigation panel they can see a list of all items with title and "Delete" button.

When the user clicks the "Delete" button, the selected item is marked as removed and does not show on the main list anymore

[2pt] Setup Backend Repo

  • Install the Linters, robocops, testing library, Bootstrap or tailwind for Styling.
  • Add git flow and Readme

[4pt] Connect Rials to Database

  • Configure Database Connection (use Postgres as your database)
  • Create 3 migration files for doctors, patients, and appointments.
  • Create Models
  • Create Controllers
  • Affirm the schema to match the ER diagram

[3Pt] Add item

When the user clicks the "Add item" link in the navigation panel they can see a form for adding a new item.

[3pt] Create details page

  • When the user selects a specific item, they can see the details page with its full description (skip the "Rotate image" button).
  • In the details page, the user can click the "Reserve" button (in the design you can see the "Configure" button - please replace it with the "Reserve" button).

image

[1pt] Create ERD

- [ ] Create entity relationship diagram according to the required design.

we will create 3 tables:

  - Doctors
  - Patients
  - Appointment

image

[3Pt] My reservations

When the user clicks the "My reservations" link in the navigation panel they can see a list of their reservations (with information about item name, date and city).

[2pt] Create login page

  • The user logs in to the website, only by typing the username.
  • we are going to use Device library.

[3Pt] Create Side Nav

In the navigation panel, the user can see links to:

/doctors/classes/items that you selected as a theme.
"Reserve" form.
"My reservations".
"Add doctor/class/item that you selected as a theme" (the link is visible to everybody).
"Delete doctor/class/item that you selected as a theme" (the link is visible to everybody).

[2pt] Setup Frontend repo

  • Setup the Front End project
  • Add all required packages
  • Setup linters
  • Update readme to include all contributors

[3Pt] Authorization

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.