README.md

📗 Table of Contents

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

📖 Exo Cars - Final Capstone (Back End)

Exo Cars is a website for renting exotic cars. It allows users to register, see the available cars and make reservations. Admin users are allowed to add and remove cars from the database.

Front-end Repo

Final Capstone Front End

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby on Rails
• Devise
• JWT
• RSpec Rails
• Rswag

Database

• PostgreSQL

Key Features

• REST API
• Authentication
• API documentation

(back to top)

🚀 Live Demo

• Front End Live Demo Link

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

Ruby

Setup

Clone this repository to your desired folder:

using HTTPS:

  git clone https://github.com/ElsonOtake/Final_capstone_backend.git
  cd Final_capstone_backend

using an SSH key:

  git clone [email protected]:ElsonOtake/Final_capstone_backend.git
  cd Final_capstone_backend

using GitHub CLI:

  git clone gh repo clone ElsonOtake/Final_capstone_backend
  cd Final_capstone_backend

Install

Install this project with:

  bundle install
  bundle exec figaro install

Add the following content to the config/application.yml and fill in your Postgres username and password:

  DATABASE_HOST: localhost
  DATABASE_USER: your_username
  DATABASE_PASSWORD: your_password

Create the database and load the initial data:

  rails db:create db:migrate db:seed

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec spec/requests
  rspec spec/models

To generate the API documentation:

  rake rswag:specs:swaggerize

(back to top)

👥 Authors

👤 Antonio Hincapié

• GitHub: @AntonioHincapie
• Twitter: @MarcoHincapie
• LinkedIn: antoniohincapie

👤 Elson Otake

• GitHub: elsonotake
• Twitter: @elsonotake
• LinkedIn: elsonotake

👤 Giuseppe Tomasini

• GitHub: @GiuseppeTG
• Twitter: @giusetomasini
• LinkedIn: Giuseppe Tomasini

👤 Gonzalo A. Medina

• GitHub: @mgmediaweb
• Twitter: @GonzoMedinaDev
• LinkedIn: gonzalo-medina-g

(back to top)

🔭 Future Features

• Implement Postgresql date range type for bookings

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• W3Schools
• Stack Overflow

This site is based on the design created by Murat Korkmaz on Behance, this design is under the Creative Commons license of the design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)