Doctors Appointment - BackEnd

📗 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
📝 License

📖 Doctors Appointment - Backend

The 'Doctors Appointment' backend is the RoR server-side for the Doctos Appointment application, where users can register and book appointments with doctors throughout the app. This server side application is the backend repository of this project, built with Ruby on Rails using PostgreSQL as the database manager

Doctors Appointment - Backend is the server repository for building the Doctors Appointment application

🛠 Built With

Tech Stack

This App backend template was built with Ruby on Rails, using Gitflow and customized Linters

Client

Ruby

Server

Rails

Database

PostgreSQL

Frontend

React Frontend Repository

Live demo - Hosting the backend

The backend is hosted in onrender

Key Features

RoR for building integrated apps
PostgreSQL as the database manager

(back to top)

💻 Getting Started

Prerequisites

Check your Ruby version or install it

ruby --version && irb

The ouput should start with something like ruby 3.1.2

If not, install the right ruby version using rbenv (it could take a while):

rbenv install 3.1.2

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

Clone the repository

git clone https://github.com/Ol-create/Doctors_Appointment_Back_End
cd doctors_appointment_back_end

Install

Ensure you have PostgreSQL installed before running the application psql --version
Run bundle install
Create a .env file in the project's root folder to assign variable values for the psql database (linked to the config/database.yml)
Run rails db:create and then rails db:migrate
Run rails server
Open Browser http://localhost:3000/

.env File Structure

See the .env.example file

Replacing the variable values where needed (most importantly username and password)

Usage

To run the project, execute the following command:

  rails server

For testing this application, a seed has been provided

The Admin username is:

username: admin
password: 12345678

Testing

To test and utilize the code, use the terminal and run ruby by inputting irb in the command line, or by using an extension in Visual Studio Code like Code runner

The user then can modify and play with the files as needed

(back to top)