gedewon / carbooking-backend Goto Github PK

4.0 1.0 0.0 175 KB

Rails backend Book car is a platform to book a car that is present in different cities for a given period of time. The user selects the duration of rental per car model type and price range. if a user is an admin he can manage the car resources by updating the list of cars in the database.

Home Page: https://carbackend.onrender.com/api-docs

License: MIT License

Ruby 99.10% HTML 0.37% Shell 0.53%

ror postgres ruby swagger-documentation

carbooking-backend's Introduction

Book car is a platform to book a car that is present in different cities for a given period of time. The user selects the duration of rental per car model type and price range. if a user is an admin he can manage the car resources by updating the list of cars in the database.

Frontend Repository

GitHub Link

Swagger API Doc

Built With

Ruby on Rails
Development set up
Rails API only
API Swagger documentation
JWT & bcrypt

Setup

Open your terminal and navigate to the folder you would like to save the project.type the following commands to your terminal

git clone [email protected]:Gedewon/CarBooking-Backend.git

Move into project directory

cd CarBooking-Backend

Available Scripts

bundle install && rails db:create db:migrate db:seed

Then bootup your database by running the following command

rails server

Testing

rake rswag

Authors

👤 Gedewon Haile

GitHub: @gedewon
Twitter: @gedewon
LinkedIn: @gedewon

🤝 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.

carbooking-backend's People

Contributors

Stargazers

Watchers

carbooking-backend's Issues

[2pts] Create User Model

The user logs in to the website, only by typing the username (a properly authenticated login is a requirement if your group is made of 5 people).

User Table Column Filed

username
password
role

[2pts] Create Reservations Model

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

Reservation
- userId
- carId
- startDate
- EndDate
- City

[3pts] Setup The Front End repo and add dependency

Setup linter and react dependency and Redux

[3pts] Create Car Action

car by providing the image , name , periceperday

[3pts] SignIn and SignUp page

Crate a frontend page for login and signup

[3pts] Document API

Document the API using Swagger

[3pts] User Registration and SignUp

User Should sign up and login to the page providing the credentials

[3pts] Database Mode

The Database Model has three tables.

User
- username
- password
- role
Car
- name
- image
- AmountperDay
Reservation
- userId
- carId
- startDate
- EndDate
- City

[1pts] Crate CORS configuration

Configure Cross-Origin Resource Sharing (CORS) mechanism that allows a server to be able to share resources with the react front-end origin

[4pts] Reservation List Page

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

[1pts] setup Routes

Define API routes / endpoint

  API/v1/resouce

[1pts] Create Reservation Action

Create a Reservation with date,username, and city .

[2pts] Create Car Model

Create Them of the website

Car Model

name
image
AmountperDay

[3pts] Setup The Back End repo and add dependency

Install Dependency
Make sure that there are no linter errors.
Make sure that you used correct Gitflow.
Make sure that you documented your work in a professional way.

[ 3pts ] Make the app responsive

Make the app responsive, creating both mobile and desktop versions

[3pts] Create Details Page

When the user selects a specific item, they can see the detail page

Kanban Setup

Group of 4 Members

link to the project: https://github.com/users/Gedewon/projects/3/views/1

[3pts] Create Main Page

On the main page, the user can see a Car

[1pts] Delete Reservation Action

When the user clicks the "Delete item" link in the navigation panel they can see a list of all items with title and "Delete" button.
When the user clicks the "Delete" button, the selected item is marked as removed and does not show on the main list anymore.