📗 Table of Contents

• 📗 Table of Contents
• 📖 Tutors Appointment Backend
  • 🛠 Built With
    • Tech Stack
    • Documentation
    • Front end
    • ERD Diagram
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Tutors Appointment Backend

Tutors Appointment Backend is an application that one can reserve a tutor from a wide variety of subjects.

🛠 Built With

Tech Stack

Server

• Ruby

database

• Postgresql

Documentation

The apps documentation can be found here.

(back to top)

Front end

The apps front-end can be found here.

Kanban board

• The Kanban board initial state
• The Kanban board final state

(back to top)

ERD Diagram

The ERD diagram can be found here.

(back to top)

Key Features

• Login
• Signup
• Create tutors
• Create reservations

(back to top)

💻 Getting Started

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

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

• Create a local directory where you can clone the project
• Clone the project to your directory by running
  • git clone https://github.com/leehaney254/tutors-appointment-backend.git
• Run Bundle install
• Create a .env file and add values for POSTGRES_USERNAME and POSTGRES_PASSWORD
• Run rails db:create db:migrate
• Run rails db:seed this also creates the admin credentials who has the priviledges to create and delete tutor
• Run rails s

Prerequisites

To run the app you need:

• A code editor
• A browser
• Install Nodejs
• Install Ruby
• Install Rails

Setup

Clone this repository to your desired folder:

• Create a local directory where you can clone the project
• Clone the project to your directory by running
  • git clone https://github.com/leehaney254/tutors-appointment-backend.git

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec

(back to top)

👥 Authors

👤 Leehaney George

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Josphat Kiploman

• GitHub: @github
• Twitter: @twitter
• LinkedIn: LinkedIn

👤 Hassan EL OUARDY

• GitHub: @codehass
• Twitter: @hassanelourdy
• LinkedIn: Hassan El OUARDY

(back to top)

🔭 Future Features

• Improve UI
• Add funcionality

(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 kindly leave a ⭐

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the great resources shared.

(back to top)

📝 License

This project is MIT licensed.

(back to top)