README.md

VEHI-GO [FRONTEND]

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License.

📖 [Vehi-Go]

[Vehi-Go] is a mock car rental web app that allows users to signup and login to be able to see available cars for rental, users are also able to add their cars to the list of cars available. The UI of the project is created with React and the backend is built with Rails API.

💻 Screenshots

🔤 Kanban board

• Link to Kanban board
  

(Frontend Kanban board screenshot before we start working on the project)

Backend links

• Link to backend API
• Link to backend Kanban board

(Backend Kanban board screenshot before we start working on the project)

🛠 Built With

Tech Stack

Client

• React.js

Server

• Rails

Database

• PostgreSQL

Key Features

• [User needs to sign up and login to use the app]
• [Using API for storing and distributing data]
• [UI is designed to acommodate both desktop and mobile screens]

(back to top)

🚀 Live Demo

• [Live Demo Link](No link yet)

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

• Computer that's connected to the internet.
• Get Ruby and React installed
• Git and Node.js installed
• Code editor (preferably VS Code)

Setup

Clone this repository to your desired folder:

commands:

  cd my-folder
  git clone https://github.com/Bludidi/vehi-go-front-end.git
  cd vehi-go-front-end

Install

Install this project with:

  npm install # to install dependencies

Usage

To run the project in the development environment, execute the following command:

  npm start 

Run tests

To run tests, run the following command:

  npm test

(back to top)

👥 Authors

Brian Buntu Ludidi

👤 Tarike Bouari

👤 Asif Amin

(back to top)

🔭 Future Features

• [3D car display ]
• [Show the loggedin user username and image ]

(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 kindly add a star to it.

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for a wonderful curriculum, and our peers also known as Micronauts for their support and motivation in this journey. Murat Korkmaz from Behance for inspiring this project design

(back to top)

📝 License

This project is MIT licensed.