Git Product home page Git Product logo

peter1907 / wheels-and-deals-api Goto Github PK

View Code? Open in Web Editor NEW
4.0 1.0 2.0 443 KB

An 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)

Home Page: https://wheels-and-deals.onrender.com/

License: MIT License

Ruby 93.87% HTML 2.14% JavaScript 1.35% CSS 2.31% Shell 0.34%
api api-documentation group-project jwt-authentication pair-programming ruby ruby-on-rails tailwindcss

wheels-and-deals-api's Introduction

logo

WHEELS AND DEALS API: RAILS BACK-END


Table of Contents πŸ“‘

πŸ“– 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

(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

πŸ‘€ David Tamayo

πŸ‘€ Diego Mero

πŸ‘€ 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)

wheels-and-deals-api's People

Contributors

cindydorantes avatar diegomero avatar ingdavidtm avatar peter1907 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

wheels-and-deals-api's Issues

[1-Pt] Tables & Migrations

  • Create and run the necessary migration files.
  • Table and column names should match:
  • User: name, email
  • Car: photo, name, description, price, reservation_fee, reserved(bool)
  • Reservation: user_id, car_id, date, city
  • Foreign keys should be included

[2-Pt] Testing cars

  • Create unit tests for models
  • Create integration tests for cars API endpoint

[1-Pt] Initialize repo

  • Create Rails App
  • Initialize Git Application
  • Set Up Postgres database
  • Set up RoR linters

[1-Pt] User Controller

  • Index for returning all users
  • (New, create) for sign-up & creating a new user
  • Necessary routes for users

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.