README.md

📗 Table of Contents

• 📗 Table of Contents
• 📖 [your_project_name]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [Bridal cars ]

[Bridal cars] is an api application built with Ruby on Rails. It provides set of endpoints that clients can use to access server data. It provides detailed information about bridal cars and car's reservations.

Link to front end react app

Front end react app

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Database

• Postgresql

Key Features

• [Provides endpoints to create, list, show, update, and delete cars]
• [Provides endpoints to create, list reservations]

(back to top)

🚀 Live Demo

• Live 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
• PostgreSQL
• Git

Setup

Clone this repository to your desired folder:

  cd desired-folder
  git clone git@github.com:inspecta/bridal-cars-backend.git

• Open the file in your preferred code editor
• Install the required dependecies with bundle install
• Update config/database.yml with your local DBcredentials.
• Then run:
  • rails db:create
  • rails db:migrate
  • rails db:seed

Run tests

To run tests, run the following command:

  rails db:seed RAILS_ENV=test to seed the testing database

  rspec

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Derrick Mulinde

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

👤 Fikerte Tesfaye

• GitHub: @Fikerte-T
• Twitter: @tofikertesfaye
• LinkedIn: LinkedIn

👤 Kolapo Precious Akinrinlola

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

(back to top)

🔭 Future Features

• [new_feature_1]
• [new_feature_2]
• [new_feature_3]

(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

We would like to thank the design provided by Murat Korkmaz on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)