/booking_app_api

Primary LanguageRubyMIT LicenseMIT

logo

📗 Table of Contents


✒️ UML Diagram

logo

📖 Booking app

Booking_app is a fullstack web application that is built on rails framework and React which allows users to make basic reservations of their favorite cars and as well add in a car for rent.

📖 Booking App Frontend

Frontend of the app is build with Javascript as language and React - Redux as Framework, to render cars, forms for reservations,login... etc visit there and Follow the prerequisites

🛠 Built With

  • Ruby
  • ROR
  • Postgresql

Tech Stack

Ruby on Rails (simplify as Rails) is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller (MVC) framework, providing default structures for a database, a web service, and web pages. It encourages and facilitates the use of web standards such as JSON or XML for data transfer and HTML, CSS and JavaScript for user interfacing.

Client
Server
Database

Key Features

Key features of the application

  • Login/Sign up
  • Make a basic reservation

Additional features

  • Admin Role
  • Only Admin can add car
  • Only Admin can delete car

(back to top)

🗎 API Documentation

Kanban Board

  • We are a group of 4 team members, and our Kanban board is divided in two parts: -- Frontend -- Backend

  • Check here Kanban Board

  • Check here initial state of the Kanban Board Screenshot

React Frontend

🚀 Live Demo

Currently, the live version of the app is not available. However, you can still view the app by following the provided prerequisites and process. Unfortunately, having a live version of a full-stack app can be quite expensive. I hope you understand the limitations we are facing. We are continuously working to improve the app and make it more accessible to everyone. Thank you for your patience and understanding.

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

Note for Frontend follow there prerequisites

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/enis-memic/booking_app_api

Install

Install this project with:

  cd booking-app-api

  bundle install

Important steps after installing project to local machine

  1. Please create .env file and add this line SECRET_KEY_BASE = your secret key.
  2. Generate secrey key by running command rails secret
  3. Check Ruby version and database.yml file. ( Insert your username and password if there is required)
  4. Please run rails db:create and rails db:migrate.
  5. Please run rails db:seed for gathering all the cars and admin user.
  6. Login for admin is: (email: admin@admin.com ; password : password)

To see app running locally

  • Please switch base url in frontend app from rendered url to our localhost url http://localhost:3000/

Usage

To run the project, execute the following command:

  npm run dev
  rails s

Run tests

To run tests, run the following command:

  bin/rails rspec spec

(back to top)

👥 Authors

👤 Enis Memic

👤 Habtamu Birru

👤 Musong Ernest

👤 Adarsh Pathak

(back to top)

🔭 Future Features

  • Search functionality
  • Page pagination

(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 give this project a ⭐️.

(back to top)

🙏 Acknowledgments

I would like to acknowledge:

(back to top)

❓ FAQ

(back to top)

📝 License

This project is MIT licensed.

(back to top)