mnaibei / appointment-app-backend

Appointment API for a car rental project.

💰 Appointment App Back-end 💸

📗 Table of Contents

• 📗 Table of Contents
• 💸 Rails APi App
• 🛠 Built With
  • 📌 Tech Stack
• 🎲 Key Features
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgments
• 📝 License

💸 Car Api

**Appointment app Back-end ** is an api only app for creating APIs to be used in the front-end so that a user who is the owner can add cars to their dashboard and a user who is a renter can reserve for rent

(back to top)

Kanban Board

Kanban Board Link

Kanban Screenshot

• We are a team of 4 for this project.

(back to top)

🛠 Built With

📌 Tech Stack

Domain	Tech Stack
Server	Ruby on Rails
Database	PostgreSQL
Testing Framework	RSpec Rails, Capybara
Authentification	Devise

(back to top)

🎲 Key Features

• Create API for user registration
• Create an API for the user to be able to Log in to an existing account
• Create an Api for the current user to be able to Sign out from a session
• Create an API so that a user who is an owner can add a car
• Create an API so that a user who is a renter can rent a car
• Check the list of transactions for a particular category
• Display the total amount of transactions for a particular category
• write test for controllers

(back to top)

🚀 Live Version

• Live

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby 3.2.2 installed

• Rails installed

Run this command to install Rails

 gem install rails

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone https://github.com/mnaibei/appointment-app-backend.git

To install dependencies, run:

bundle install

Set up the database

To create the database, run:

rails db:create

To create the schema, run:

rails db:migrate

Usage

To run the project, execute the following command:

Example command:

  rails server

Run tests

To run tests, run the following command:

  rspec

API Documentation

• Live api docs

  localhost:3000/api-docs

(back to top)

👥 Authors

🤑 Obed Bamfo

• GitHub: @obed300
• LinkedIn: Obed Bamfo

🤑 Mucha Naibei

• GitHub: @mnaibei
• LinkedIn: Mucha Naibei

(back to top)

🔭 Future Features

• Create an Api so that a user can who is an owner can see the number of car sold on the app
• Create an Api so that a user can buy a car through the app

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Your support is crucial to the success of this project! There are ways you can contribute and show your support:

• Provide Feedback: If you've tried out the project or have any suggestions for improvement, I would love to hear from you. Your feedback is invaluable in shaping the future direction of the project.

• Kindly Give a 🌟 STAR 🌟 if you like this project!

Remember, your support matters! Whether it's spreading the word, providing feedback, reporting issues, contributing code, or making a donation, every action makes a difference. Together, we can make this project even better.

Thank you for your support and for being a part of this journey! ❤️

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• https://www.behance.net/muratk for the original design idea
• Code Reviewers

(back to top)

📝 License

This project is MIT licensed.

(back to top)