Giter Club home page Giter Club logo

tan12082001 / vehicle-booking-app-backend Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 2.0 139 KB

Vehicle-Booking-App is an booking appointment application that would allow users to subscribe to the app and be able to book an car. A user can add new cars, make reservations to those cars and delete the cars. And this is a supporting API rails applications consisting RESTful API actions.

License: MIT License

Dockerfile 2.50% Ruby 84.13% HTML 9.37% Batchfile 3.75% Shell 0.25%
postgresql-database rails-api rails-server

vehicle-booking-app-backend's Introduction

๐Ÿ“— Table of Contents

๐Ÿ“– vehicle booking app

vehicle booking app is a Booking app made connectively with Ruby in Rails and React for front-end vehicle booking app React frontend App in JSON format through an API endpoint.

๐Ÿ›  Built With

Tech Stack

Client
- Server

Key Features

  • Rails API backend
  • React Front-end
  • Redux Toolkit used to consume the backend api

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

Setup

Use the following URL to clone this project:

git clone https://github.com/tan12082001/Vehicle-Booking-App-Backend.git

Install

Open the terminal in the root directory of the project and run the following command to install all dependencies.

- bundle install
- secret_base_key generation
  In terminal: 
  * rm credentials.yml.enc
  * $ EDITOR="mate --wait" bin/rails credentials:edit

- configure database
  In terminal: 
  * run `rails db:create`
  * run `db:migrate`

- Rspec
  In terminal: 
  * bundle exec rails db:schema:load RAILS_ENV=test

Frontend Repository

Reference the Frontend Repository for the corresponding frontend.

ERD Image

ERD image to visualize the database schema

API Documentation

For details on how to interact with the API, view the API documentation. Follow the steps below:

- run server `rails s`
- open in browser `http://localhost:4000/api-docs`

Usage

To start the development server, run the following command then navigate to localhost:4000 in your browser.

rails s

Open http://localhost:4000 to view it in your browser.

Run tests

To run tests, use the following command:

  rspec

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Suleiman Gacheru

๐Ÿ‘ค Tanmayi manku

๐Ÿ‘ค Nweneary Uzochukwu Winnie

๐Ÿ‘ค Bolaji Toyib

(back to top)

๐Ÿ”ญ Future Features

  • None planned

(back to top)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

If you like this project, please give it a star โญ๏ธ and share it with your friends.

(back to top)

๐Ÿ™ Acknowledgments

I would like to thank Microverse for providing the resources and guidelines that enabled me to complete this project.

(back to top)

๐Ÿ“ License

This project is MIT licensed.

vehicle-booking-app-backend's People

Contributors

hetrox8 avatar simpleshaikh1 avatar tan12082001 avatar wineshuga avatar

Watchers

 avatar

Forkers

wineshuga hetrox8

vehicle-booking-app-backend's Issues

[ 1.5pt ] - Navigation Panel

The navigation panel should have:

  • Selected Item link
  • Reserve form link
  • My reservations link
  • Add new item link
  • Delete item link (visible to everybody).

Should follow the wireframe:

Image

[ 2.5pt] - Item Details Page

When the user selects the specific item should be able to see the item's details page.

  • The details page should have its full description.
  • The 'Reserve' button (instead of the 'Configure' button).
    NOTE: Can skip the rotate image button from the wireframe).

Should follow the wireframe:

Image

[2pt] - Delete Action page - Backend

The user should be able to do/see the following:

  • When the user clicks the "Delete" button, the selected item is marked as removed and does not show on the main list anymore.

[ 2pt ] - Home Page

The home page renders the list of items and update the styles.

Follows the wireframe:

Image

[2pt] - Reserve form page

The following should be implemented:

  • To reserve an appointment, the user has to select a date and city (username and selected item are auto-filled).

  • Use the design based on the "Book a vespa test-ride" and add all necessary inputs.

  • The user can also access the "Reserve" page from the navigation panel. In that case, only the username is auto-filled.

Image

[1.5pt] - My reservation - frontend

Implement the following:

  • When the user clicks the "My reservations" link in the navigation panel they can see a list of their reservations (with information about item name, date, and city).

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.