otmanTR/nice-car-back-and

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Nice Car Renta Application

Nice Car Rentals Application contains the backend code for a Car Rental App, which allows users to reserve a car, add new cars, and delete existing ones. The backend is built using Ruby On Rails and communicates with the frontend of the app to provide a seamless user experience. The backend includes functionality for user authentication and authorization, allowing only authorized users to perform actions such as adding or deleting cars. It also includes a Postgresql database to store information about the cars available for rental, as well as information about user reservations.

🛠 Built With

• Rails

• Postgresql

Key Features

• See various car models
• Reserve cars
• Add cars
• Delete cars

Front End App

Click here to acess the frontend app that was built with react.

API Documentation

• Check swagger documentation

Kanban Board

• Link to kanban board

• Our team consist of 4 members: @burakotman @jodavid444 @alicemirigo @becky

Intial state 👇

After 1 week iteration 👇

The Second Week of iteration 👇

(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:

• Install ruby on your computer or run it with docker.

• Install Rails

• Install Postgresql

Setup

• First Clone this repository to your desired folder by using the command line:

run this commands:

git clone https://github.com/otmanTR/nice-car-back-and

• Open a .env.example file at root directory and fill parameters accordingly.

• Example:

RAILS_DATABASE_USER=user
  RAILS_DATABASE_PASSWORD=12345678

• Rename the file to .env

Install

• Install all the gems with the following command:

bundle install

Usage

• To run this project follow the next steps:

• Create database with the following command:

rails db:create

• Apply migrations with the following command

rails db:migrate

• [Optional] Run the following command to fill the database with data:

rails db:seed

• Rub the app by executing:

rails server

Run Tests

To run test execute the following command:

rspec spec --exclude-pattern "spec/requests/swagger/**/*_spec.rb"

Deployment

• You can deploy this project on render:

• Follow the steps in this [documentaion] (https://render.com/) to deploy a rails app.

Authors

👤 Joseph David

• GitHub: @jodavid444

• Twitter: @jodavid444dave

• LinkedIn: @joseph-david

👤 Recep Burak Otman

• GitHub: @otmanTR

• Twitter: @hotumanzade

• LinkedIn: @burakotman

👤 Alice Mirigo

• GitHub: @alicemirigo92

• Twitter: @GathoniMirigo

• LinkedIn: @alicemirig

👤 Rebbeca Nabwire

• GitHub: @Becky449

• LinkedIn: @rebbeca nabwire

(back to top)

🔭 Future Features

• [Add raing system]
• [Update car details]
• [Filter user by their 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

If you like this project please leave a star. Thank you 🙏

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for the great project idea.

• Unsplash for providing content related free pictures.

• Thanks to my teammates, learning and coding partners.

(back to top)

📝 License

This project is MIT licensed.

(back to top)