apt2tell / i-model-cars-backend

📗 Table of Contents

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

📖 Capstone - i-model-cars

Ruby on Rails

i-model-cars app helps users to book/make a reservation for latest model cars. It allows user to log in with username and e-mail and then reserve, add/create and delete cars. It is built on Rails API with React using Rubygem and npm as software packages system.

🛠 Built With

Ruby 3.1.3 > postgresql > Rails 7 > React

Kanban board

Link to kanban board

Team members: 3

Tech Stack

Backend/Frontend

• Rails
• Rails

Key Features

• Car Models
• Reservations
• API

(back to top)

🚀 Live Demo

• Live Link
• Link to frontend repo.
• Link to API documentation

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

• A Desktop or Laptop Computer running on with Windows, Mac OS or Linux operating system.
• Rails installed on the Computer

Setup

Clone these repositories to your desired folder:

• https://github.com/GordonOtieno/i-model-cars-backend.git and

• https://github.com/GordonOtieno/i-model-cars-frontend.git if you prefer ssh and hit enter.

• create a directory in your preferred location (e.g in the Desktop or Document directory)

  Setup Database

  To setup database locally run the following command:

  • rails db:create to create database locally.
  • rails db:migrate to create migration files.
  • rails db:seed to add initial data to db.

Install

Install this project with:

• Install Ruby on Rails framework.
• Use RubyGems as a software package system.
• Dependencies (a packet manager is required): then you run the command bundle install in the terminal

Usage

To run the project, execute the following command:

• rails server
• This will run the project in the terminal in the specified directory

Run tests

To run tests, run the following command:

• rspec spec
• This will run all tests on your local machine

(back to top)

👥 Authors

👤 Okechukwu Muokwugwo

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

👤 Gordon Otieno

• GitHub: @GordonOtieno
• Twitter: @GordonOtieno
• LinkedIn: GordonOtieno

👤 Amine

• GitHub: @ouasamine
• Twitter: @ouass_amine
• LinkedIn: LinkedIn

(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 then kindly give me a star ⭐️ in the project repository.

(back to top)

🙏 Acknowledgments & Attribution

• I would like to thank Gregoire Vella on Behance
• Hat tip to anyone whose code was used.
• Inspiration, etc.

(back to top)

📝 License

This project is MIT licensed.

(back to top)