theodoraldo / fix-mate-backend

Fix Mate is committed to making everyday life more convenient by connecting users with trusted service providers. It is a one-stop platform for finding, booking, and reviewing services, all from the comfort of your home.

FixMate

📗 Table of Contents

• 📗 Table of Contents
• 👨‍💻 Fix Mate
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Installation
    • Database Setup
    • Running the App
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • 💖 Show your support
  • 🙏 Acknowledgments
  • 📝 License

[ 👨‍💻 Fix Mate ]

Fix Mate is committed to making everyday life more convenient by connecting users with trusted service providers. It is a one-stop platform for finding, booking, and reviewing services, all from the comfort of your home. Users can communicate with service providers through the app, discussing specific requirements, asking questions, and confirming details.

API

• Base Url

• API Endpoints

• api/v1/experts
• api/v1/reservations
• api/v1/specializations

• API Documentation

Link to Front End

• Live Link

• Link to Front-end Repository

Kanban Board Link

• Link to Kanban Board

• Kanban Board Screenshot

• Number of Team Members - 4

Entity Relationship Diagram

🛠 Built With

Tech Stack

Server

• Ruby
• Ruby On Rails

Database

• PostgreSQL

Key Features

The key features of this project include.

• Show all Experts
• Reserve an Expert
• Show my Reservation
• Add an Expert
• Delete an Expert
• Add a Specialization

(back to top)

💻 Getting Started

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

Prerequisites

Before you begin, make sure you have the following installed on your machine:

• Ruby: You can download Ruby here.
• Rails: You can install Rails by running the command gem install rails in your terminal.
• Postgres: You can install Postgresql here.
• A code editor (like VSCode, Sublime, Atom, etc.): You can download VSCode here, Sublime here, and Atom here.
• Git: You can download Git here.
• Node.js: You can download Node.js here.

• Version Requirements:

  ruby >= 3.2.0
  rails >= 7.0
  postgres >- 15.3

Setup

• To setup this project locally:

1. Open terminal in VScode.
2. Navigate to the directory where you want clone the copy of this repository.
3. Create new directory [optional].
4. Clone the repository by running the following command:

git clone https://github.com/anita00001/fix-mate-backend.git

5. Navigate into the cloned repository:

cd fix-mate-backend

Installation

1. Install the required dependencies by running the following command:

bundle install

2. Delete files /config/credentials.yml.enc and /config/master.key, (if any).
3. Run the command to get the pairs of credentials and master key

rails credentials:edit

Database Setup

• To create the database, run the following command:

rails db:create

• To migrate the database schema, run the following command:

rails db:migrate

• Feed Sample data through seeds

  rails db:seed

Run Test

• Run Linters Check with Rubocop

  rubocop

• Run Test with RSpec

rails db:migrate RAILS_ENV=test && rspec spec

Running the App

• To run the application, run the following command:

rails server

• This will start the Rails development server and you can access the application by visiting http://localhost:4000 in your web browser.

(back to top)

👥 Authors

The collaborators of this project.

👤 Anita Sharma

• GitHub
• LinkedIn
• Twitter

👤 Ansar Ibrahim

• GitHub
• LinkedIn
• Twitter

👤 MoFuhidy

• GitHub
• LinkedIn

👤 Theodore Asimeng-Osei

• GitHub
• Twitter
• LinkedIn

(back to top)

🔭 Future Features

• Delete Specializations
• Add Admin Role

(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 a ⭐️, if you like this project!

(back to top)

🙏 Acknowledgments

• We would like to thank Microverseinc for Readme-template, our code reviewer and external evaluator. We would extend our sincere gratitude to Murat Korkmaz on Behance for provinding the original design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)