WHEELS AND DEALS API: RAILS BACK-END

Table of Contents 📑

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Entity Relationship Database
    • Key Features
  • 📅 Project Kanban Board
  • 🚀 Live Demo
• 📷 Documentation Screenshots
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License
  
  

📖 WHEELS AND DEALS: REACT FRONT-END

Wheels and Deals API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

It's a simple API that is linked to the Wheels and Deals Frontend . It holds all the data for the frontend to display, as well as the information of the users (Names, Emails & Passwords)

🛠 Built With

Tech Stack

Client

• 
• 

Server

• 

Database

• 

Authentication

• 

Entity Relationship Database

(back to top)

Key Features

• Authentication Endpoints: POST
• Users Endpoints: GET, POST
• Cars Endpoints: GET, POST, DELETE
• Reservations Endpoints: GET, POST, DELETE
• Documentation available here

(back to top)

📅 Project's Kanban Board

Kanban Board available here

The team of developers involved in the creation of this project is made up of 4 authors.

🚀 Live Demo

• Live Demo Link

(back to top)

📷 Documentation Screenshots

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

   gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Peter1907/wheels-and-deals-api.git

Install

Install this project with:

  cd wheels-and-deals-api
  bundle install

Usage

To run the project, execute the following command:

  rails db:create
  rails db:migrate
  rails s

Run tests

To run tests:

• Remove config/master.key and config/credentials.yml.enc
• Run:

  EDITOR=code rails credentials:edit

This command will create a new master.key and credentials.yml.enc if they do not exist

• Then run the following command:

  bin/rails spec

(back to top)

👥 Authors

👤 Cindy Dorantes

• GitHub: @CindyDorantes
• Twitter: @CindyDorantes10
• LinkedIn: Cindy Melisa Dorantes Sánchez

👤 David Tamayo

• GitHub: @IngDavidTM
• Twitter: @David5TM
• LinkedIn: David Tamayo

👤 Diego Mero

• GitHub: @DiegoMero
• Twitter: @Dimero18
• LinkedIn: Diego Mero

👤 Peter Beshara

• GitHub: @Peter1907
• Twitter: @Peter_Beshara_
• LinkedIn: Peter Beshara

(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! Also, you can reach out any author, we will be glad to hear you.

(back to top)

🙏 Acknowledgments

• Thanks to our learning partners for their help and support.

(back to top)

📝 License

This project is MIT licensed.

(back to top)