📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
  • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
• Run tests
• Documentation
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Doctor Appointment Backend

Doctor Appointment Backend Is a ruby on rails backend for a react/redux front end app. This deployed app serves the endpoints for users to signup, login, logout, create a doctor, fetch all doctors, remove a doctor, create an appointment, fetch all appointments, and delete an appointment, all with authentication.

##ERD

🛠 Built With

Tech Stack

• Ruby
• Ruby on Rails

• Link to Front End of Project

Key Features

• Data Model for users, doctors and appointments.
• Controllers with authentication for users, doctors and appointments.
• Endpoints for creating, logging in and signing out users.
• Endpoints for adding, updating, deleting and fetching doctors and appointments.
• Devise and JWT for Authentication
• Deployment
• API documentation

Kanban

Our team has 4 members

• Kanban before
• Kanban After

Getting Started

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

Prerequisites

You need the following tools be installed in your computer:

• Git
• Ruby
• Ruby on Rails
• IDE
• Etc

Setup

Clone this repository to your desired folder:

  cd my-prefered-folder
  
  git clone https://github.com/sylvester-wamaya/doctor-appointment-backend.git

Install

Install this project with:

  cd doctor-appointment-backend
  
  bundle install

Update database.yml file with database credentials

• Navigate to config/database.yml
• Update the user and password to match your postgresql user and password.

Generate Devise secret Key

• Remove config/master.key and config/credentials.yml.enc if they exist.
• Run rails secret. Copy the key.
• Run EDITOR="code --wait" bin/rails credentials:edit
• In the editor that opens, add this: devise_jwt_secret_key: <the key you copied in step 2>
• Save the file and close the editor. New master.key, credentials.yml.enc files will be generated, and the key will be stored in Rails.application.credentials.devise_jwt_secret_key.

Create database and migrate

Run the following code-

  rails db:create
  rails db:migrate

Run server

  rails s

Run tests

To run tests, run the following command:

Run the rspec command in your console to run the tests.

Documentation

• The documentation for the API can be found here

👥 Authors

👤 Clinton Younge

• GitHub: @ClintonYounge
• Linkedin: @clinton-younge
• Twitter: @YoungeCjay

👤 Sylvester Wamaya

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Mariano Benjamin

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Adeyemi Olusola

• GitHub: @emarkees
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Cancancan for admin, user and guest authorization.

(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 feel free to leave a star to show your support.

(back to top)

🙏 Acknowledgments

We would like to give thanks to Microverse for providing an environment that makes us strive to grow as developers.

(back to top)

📝 License

This project is License licensed.

(back to top)