/bytecar_api

REST API for bytecar web application built with Ruby on Rails

Primary LanguageRubyMIT LicenseMIT

ByteCar API

image

This is the back-end API for ByteCar, an app in which you can test drive a car.

  • Sign up and sign in to access the app.
  • Choose from our list of electric car.
  • Watch a detailed view of each car profile.
  • Reserve a test drive for a car up to one month from any date within the next six months.
  • Manage all your reservations from one page.
  • users can add and delete providers if needed.

The API has endpoints for users / providers / reservations / skills / password recovery.

Read the complete documentation here.

UI Repo

Check the UI of this App here.

Built With

  • Ruby 3.1.2
  • Ruby on Rails 7.0.3
  • PostgreSQL

Getting Started

To get a local copy up and running follow these simple example steps.

  • Click on the top right green "code" button.
  • On the dropdown menu, choose "download with zip" button.
  • After download, extract the zip file and you have the project on your machine.
  • Make sure that your PostgreSQL server is running and you have the ability to establish connection with the database.
  • Execute rails db:create to create the database.
  • Execute rails db:migrate to migrate the database.
  • Run rails s to run the application.

Tests

  • If you want to run some unit tests, all you need to do is:
  • On your terminal execute: gem install rspec
  • Run the rspec command in this case over the path of spec/, the resulting command will look like this: rspec spec/.
  • If you want to run the tests over the entire project, you can execute the following command: rspec

Deployment

Live UI

API Link

Kanban Board

In this project 3 developers have participated, connect with them in the authors section.

Check out the backend(API) kanban board: https://github.com/users/jr-cast/projects/8

This was the kanban board a the beggining of the project

Start_kanban_board

Authors

👤 Jose

👤 Hector Torres

👤 Fabiano Frank

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.