DriveWise Backend

📗 Table of Contents

• 📖 About the Project
• Frontend
• Kanban Board
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Setup database
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 DriveWise Backend

[DriveWise Backend] is a Ruby on Rails API that serves data to the DriveWise Frontend application. It is a RESTful API that allows users to create, read, update, and delete data from the database.

Frontend

• The link to the frontend repository of the app can be found here

Kanban Board

• The Kanban board can be found here
• Screenshot of the initial state of our Kanban board can be found here

🛠 Built With

Tech Stack

Framework

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User - Create, read, update, and delete users
• Car - Create, read, update, and delete cars
• Reaservation - Create, read, update, and delete reservations.

The API endpoints are:

Users

• GET /users
• GET /users/:id
• POST /users
• PATCH /users/:id
• DELETE /users/:id

Cars

• GET /cars
• GET /cars/:id
• POST /cars
• PATCH /cars/:id
• DELETE /cars/:id

Reservations

• GET /reservations
• GET /reservations/:id
• GET /users/:user_id/reservations
• GET /cars/:car_id/reservations
• POST /users/:user_id/reservations
• PATCH /users/:user_id/reservations/:id
• DELETE /users/:user_id/reservations/:id

(back to top)

🚀 Live Demo

• Backend Demo Link

• Frontend Demo Link

(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
• Rails
• PostgreSQL

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:iamchristianani/drivewise-backend.git

Install

Install this project with:

  cd drivewise-backend
  bundle install

Setup database

Setup database with:

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

Usage

To run the project, execute the following command:

  rails server

To test the endpoints with swagger, visit:

  http://localhost:3000/api-docs

Run tests

To run tests locally, run the following command:

  rspec

(back to top)

👥 Authors

We have a total number of 4 team members, namely:

👤 Yuvenal Njoroge

• GitHub: @yuvenalmash
• Twitter: @YuvenalNjoroge
• LinkedIn: Yuvenal Njoroge

👤 Roy Jumah

• GitHub: @RoyJumah
• Twitter: @roy_issues
• LinkedIn: Roy Jumah

👤 Christian Ani

• GitHub: @iamchristianani
• Twitter: @kriznode
• LinkedIn: Christian Ani

👤 Ahmed Abas

• GitHub: @boo-shehab
• Twitter: @boo-shehab2000
• LinkedIn: @ahmed-al-ali-77b6a0246

(back to top)

🔭 Future Features

• [Authentication] - Add authentication to the API endpoints to allow only authorized users to access the data.
• [Authorization] - Add authorization for only admin users to access some specific data.

(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, give it a ⭐️!

(back to top)

🙏 Acknowledgments

I would like to thank all the contributors to this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)