README.md

Travenjo

A smart trip management application
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact

About The Project

An intra city trip management application with following benifits

1. Reduce cancellation from rider and driver end.
2. Cost optimization for both rider and driver.
3. Built up on the top of the existing cab provider systems.
4. Providing better pricing and a wide range of riding options under a single platform.

(back to top)

Built With

• Java
• Spring Boot
• MySQL
• HTML
• CSS
• JavaScript

(back to top)

Getting Started

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

Prerequisites

Your system should have below mandatory setups

• Java 11 (minimum)
• MySQL server
• Gradle installed (Gradle Installation Step)
• Any Webserver for Frontend - Apache / Nginx etc
• Google Map API Key (Steps to Generate)

Installation

1. Clone the repo

   git clone https://github.com/abhishek423/travenjo.git

2. Backend Setup

   i) Database Setup

   • Run the MySQL server

   • Create database named travenjo in your SQL server

   • Import the DB from resource folder of backend mentioned here for required sql setup in local

   ii) Copy the backend folder in your respected workspace

   iii) Run below command inside the backend folder to build the application in your workspace

   gradle build

   iv) Similarly run below command for start the application after successful build

   java -jar .\build\libs\travenjo-0.0.1-SNAPSHOT.jar

3. Frontend Setup

   i) Copy the frontend folder in any websever (e.g. Apache / Nginx) and it should work.

   ii) Please update the API key in rider/book-ride.html file to connect with google map API service. You can look for the script import of Google Map API and replace your key in the place "Your_Key_here". You can generate an API key from here

(back to top)

Usage

Please refer

• Wireframe
• API Documentation - We have used swagger for API documentation.

(back to top)

Roadmap

• Normal Ride Booking for External Cabs Service (Ola, Uber)
• Split Ride for External Cabs Service (Ola, Uber)
• Emergency Ride for External Cabs Service (Ola, Uber)
• Confirm trip to External Cabs Service (Ola, Uber)
• Extra fare for reaching to a rider for pickup
• Extra fare for reaching to a better location after drop off
• Extend to inter-city trips as well
• Schedule Future Ride

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Owners:

• Kousik Mandal - [email protected]
• Pradipto Chaudhury - [email protected]
• Abhishek Sarkar - [email protected]

Project Link: https://github.com/abhishek423/travenjo

(back to top)