zhadier / RentUrTechBackend

This is a Ruby on Rails API part of a full-stack project called "RentUrTech" (check the link to the front-end below). The main goal of this project is to provide users with an environment to reserve a specific product for a set amount of time. Thus, in this application users can create an account, can get an authorization token, and can retrieve all or one piece of equipment. They will be required to have an authorization token to manage their own reservations. For creating and destroying equipment, the user needs a proper role. Feel free to take this project and modify it for your own business use!

Home Page:https://documenter.getpostman.com/view/19411270/Uz5KnaUD#intro

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

RentUrTech API

This is a Ruby on Rails API part of a full-stack project called "RentUrTech" (check the link to the front-end below). The main goal of this project is to provide users with an environment to reserve a specific product for a set amount of time. Thus, in this application users can create an account, can get an authorization token, and can retrieve all or one piece of equipment. They will be required to have an authorization token to manage their own reservations. For creating and destroying equipment, the user needs a proper role. Feel free to take this project and modify it for your own business use!

API Full Documentation

Much more populated documentation for this API was made with Postman and can be found here. It includes all the available methods, required headers and parameters, and examples for different responses

Front-end Repository

You can find the front-end repository right here to check the code used in the website to implement this API. This project was made with React and Redux

Requirements

In order to work on this project, you need to have the following dependencies installed:

Built With

  • Languages: Ruby 3.1.2
  • Frameworks: Ruby On Rails
  • Technologies used: Visual Studio Code

Getting Started

Clone this repository

$ git clone git@github.com:Final-Capstone-Elite-Group/RentUrTechBackend.git
$ cd RentUrTechBackend

Commands to run

Run

$ bundle install

To get all the gems required for the project

To check linters locally, use

$ rubocop

Once you have the project correctly set up, run

$ bin/rails db:setup

To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes

Finally, each time you make changes to the project, run

$ bundle exec rspec /spec

In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description.

Authors

Back-end Team

👤 Andrés Felipe Arroyave Naranjo

Platform Badge
GitHub @JohnFTitor
Twitter @johnftitor
LinkedIn Andres

👤 Jose Abel Ramirez

Platform Badge
GitHub Jose Abel Ramirez
LinkedIn Jose Abel Ramirez Frontany

Front-end Team

👤 Zeeshan Haider

Platform Badge
GitHub @zhadier
LinkedIn Zeeshan Haider

👤 Nicolas Gonzalez

Platform Badge
GitHub @Nicolaswg
Twitter @Nicolas54146830
LinkedIn nicolas-gonzalez

👤 LeonardoAlbornoz

Platform Badge
GitHub: @Leboroz
Twitter: @Leboroz
LinkedIn: Leonardo Albornoz

Kanban board

You can check our Kanban board image

Group Members Count

For this final Capstone project we were a total of 5 members

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project!

About

This is a Ruby on Rails API part of a full-stack project called "RentUrTech" (check the link to the front-end below). The main goal of this project is to provide users with an environment to reserve a specific product for a set amount of time. Thus, in this application users can create an account, can get an authorization token, and can retrieve all or one piece of equipment. They will be required to have an authorization token to manage their own reservations. For creating and destroying equipment, the user needs a proper role. Feel free to take this project and modify it for your own business use!

https://documenter.getpostman.com/view/19411270/Uz5KnaUD#intro

License:MIT License


Languages

Language:Ruby 99.7%Language:HTML 0.3%