TravelBuddy

project_description
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. License
7. Contact
8. Acknowledgments

About The Project

This is a peer to peer ride sharing project , specifically for a college community to facilitate easy and cheaper commute everyday!

8b9c6d40-4829-4e3d-803a-dc022c3d13fc.mp4

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/rajitk13/TravelBuddy.git

3. Install NPM packages

   npm install

4. Enter your KEY .env in ./backend/src/

   SECRET_KEY="MILINDISHANDSOME"
   JWT_EXPIRES_IN="604800s"

(back to top)

Usage

(back to top)

Roadmap

• Backend basic routes
• React intialisation
• Authentication
• Creating Requests
• Displaying all Requests in Explore page

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

(back to top)

Contact

Project Link: https://github.com/rajitk13/TravelBuddy

(back to top)

Acknowledgments

• Deadpool 1000 (https://github.com/Deadpool-1000)
• rajitk13 (https://github.com/rajitk13)

(back to top)