PraisesPJMT / Vip_Cars_Rails

A server-side of a fullstack web application that is built with Ruby-on-Rails which allows users to make basic reservations of their favourite cars and as well add in a car for rent..

📗 Table of Contents

• 📗 Table of Contents
• 📖 [VIP_CARS_RAILS]
  • 📇 UML Diagram
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🗎 API Documentation
  • 🗎 Kanban Board
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 [VIP_CARS_RAILS]

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

📇 UML Diagram

🛠 Built With

• React, javascript
• Rails

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

• REACT

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

Key features of the application are

• Login/Signup
• Make a basic reservation
• Add a car for rent

(back to top)

🗎 API Documentation

• Check here API documentation VIP cars API

Kanban Board

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

• Check here Kanban Board Kanban Board

• Check here Kanban Board Backend screenshot: Kanban Board Backend

• Check here Kanban Board Frontend screenshot: Kanban Board Frontend

React Frontend

• Frontend part of the project VIP_Cars_Frontend

🚀 Live Demo

• Live Demo

(back to top)

💻 Getting Started

This project can be used by anyone for any good purpose.

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

Prerequisites

In order to run this project you need:

• Ruby and Rails on you operating system eg. for Ubuntu 20.04
• React.js
• Node.js installed
• PostgreSQL database installed

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/edi-sipka/Vip_Cars_Rails

Install

Install this project with:

  cd VIP_CARS_RAILS

  bundle install

Important steps after installing project to local machine

1. Please add .env file with devise secret key.
2. Please run rails db:seed for gathering all the cars.
3. Please run rails db:create and rails db:migrate.
4. Check Ruby version and database.yml file. ( Insert your password if there is required)
5. Login for admin is: (email: [e-mail] ; password : 123123)

Usage

To run the project, execute the following command:

  npm run dev

Run tests

To run tests, run the following command:

  bin/rails rspec spec

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Edi Sipka

• GitHub: @Edi-Sipka
• Twitter: @sipka_edii
• LinkedIn: Edi Sipka

👤 Praises Tula

👤 Nonhlanhla

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Youta Christabelle

• GitHub: Christabelle143
• Twitter: @christabelleyo
• LinkedIn: YoutaChristabelle

👤 Okolike Assumpta

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(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 buy the team a drink

(back to top)

🙏 Acknowledgments

I would like to acknowledge:

• Microverse for the opportunity to work on this project
• The creative common for the design
• Design from Murat Korkmaz on Behance

(back to top)

❓ FAQ

• Is Rails still relevant?

  • Yes, Rails is still popular among developer

• Is it easy to learn Ruby on Rails

  • It is very easy to learn compared to most of the programming languages

(back to top)

📝 License

This project is MIT licensed.

(back to top)