Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/baqar-abbas/appointment-app-back-end


https://github.com/baqar-abbas/appointment-app-back-end

Last synced: about 21 hours ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Doctor Appoinment App

- Doctor Appointment App is a web-based application designed to streamline and simplify the process of scheduling and managing appointments with healthcare providers. This open-source project aims to provide a user-friendly interface for patients to book appointments, view their medical history, and receive reminders for upcoming visits. Additionally, it offers healthcare professionals a platform to manage their schedules and access patient information efficiently.

- [Link to front end Repository](https://github.com/baqar-abbas/appointment-app-front-end)

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **[Add an Appoinment]**
- **[Reserve an Appoinment]**
- **[Delete an Appoinment]**
- **[New user sign up functionality]**
- **[New user login functionality]**
- **[Admin user Add doctors]**

(back to top)

## 🚀 Live Demo https://doctor-app-u5x6.onrender.com/

- [Doctor Appoinment App]()

(back to top)

## 💻 Getting Started

To get started with the app, you'll need to have Node.js installed on your system. Node.js is a JavaScript runtime that allows you to run JavaScript code outside of a web browser.

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

### Prerequisites

Ruby - The app is built on the Ruby programming language, so you'll need to have Ruby installed on your system. You can download Ruby from the official website.

Ruby on Rails - Rails is a web application framework built on Ruby. You'll need to have Rails installed on your system to run the app. You can install Rails using the following command in your terminal:

```sh
gem install rails
```

PostgreSQL - PostgreSQL is an open-source relational database management system used by the app to store and manage data. You'll need to have PostgreSQL installed on your system to run the app.

### Setup

First, clone the Github repository to your local machine. You can do this by running the following command in your terminal:

```sh
git clone https://github.com/baqar-abbas/appointment-app-back-end
```

### Install

Navigate to the project directory in your terminal and run the following command to install the app's dependencies:

```sh
bundle install
```

Before running the app, you'll need to set up the database. To do this, run the following commands in your terminal:

```sh
These are the steps:

1. Remove config/master.key and config/credentials.yml.enc if they exist.
2. Run in the terminal: EDITOR=code rails credentials:edit
3. Close the editor that opens.
4. This command will create a new master.key and credentials.yml.enc if they do not exist.

rails db:create
rails db:migrate
rails db:seed
```

### Usage

To start the app, run the following command in your terminal:

```sh
rails server
```

### Run tests

- Run the following command to run all tests:

```
rspec
```

(back to top)

## 👥 Authors

👤 **A.I.M. Shihab Uddin Khan**

- GitHub: [@shihabrafio](https://github.com/shihabrafio)
- LinkedIn: [Shihab Uddin Khan](https://www.linkedin.com/in/shihab-uddin-khan-45620a16a/)

👤 **Baqar Abbas**

- GitHub: [@Baqar](https://github.com/baqar-abbas)
- Twitter: [@BaqarAbbas9](https://twitter.com/BaqarAbbas9)
- LinkedIn: [Baqar Abbas](https://www.linkedin.com/in/baqar-abbas/)

👤 **Amarachi Dimkpa**

- GitHub: [@amazinggacee](https://github.com/Amazinggracee)
- Twitter: [@amazinggaceu](https://twitter.com/amazinggraceu)
- LinkedIn: [Amarachi Dimkpa](https://linkedin.com/in/amarachi-dimkpa-070643183)

(back to top)

## 🔭 Future Features

- [ ] **[Register with email and password.]**
- [ ] **[Edit doctor & patient details.]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

- If you like this project please give it a star ⭐️.

(back to top)

## 🙏 Acknowledgments

- The design provided by [Murat Korkmaz](https://www.behance.net/muratk) on Behance.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)


````