📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
  • 🚀 Live Demo
  • 🚀 Link to the FrontEnd App
  • 🚀 Kanban board
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 QuickMaths Backend

QuickMaths Backend is a cutting-edge booking application designed to help students of all ages and skill levels find a qualified math tutor quickly and easily.

🛠 Built With

Tech Stack

• Ruby
• Ruby on Rails

Key Features

• Api endpoint to retrieve a list of tutors
• Api endpoint to retrieve a list of reservations
• Api endpoint to make/delete a reservation
• Api endpoint to add a tutor

🚀 Live Demo

Link

🚀 Link to the FrontEnd App

Link

(back to top)

🚀 Kanban board

Kanban Link
Kanban screenshots

3 members

• Hayet Fellah
• Florin Voicu
• Daron Wiafe

(back to top)

💻 Getting Started

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

Prerequisites

• A web browser
• A code editor
• Ruby, Ruby on rails and Postgres installed on your machine

Setup

Clone this repository to your desired folder:

git clone https://github.com/laiifuu/QuickMaths-BackEnd.git

Install

Then install the project's necessary dependencies with:

bundle install

Setup database

Setup the database with the following:

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

Run the app:

Run the app by starting the server with:

rails s

Then open the link on your browser:

http://127.0.0.1:3000/

(back to top)

👥 Authors

👤 Hayet Fellah

• GitHub: @laiifuu
• Twitter: @hayet_fe

👤 Florin Voicu

• GitHub: @vflorin1995
• LinkedIn: @florin--voicu

👤 Daron Wiafe

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

(back to top)

🔭 Future Features

• [ ] Implement proper authentication

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give this project a ⭐️ if you like it !

(back to top)

🙏 Acknowledgments

• Shout out to our previous Rails projects ;)

(back to top)

📝 License

This project is MIT licensed.

(back to top)