Report Bug | Request Feature | Contribute to Project

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

Welcome to Yatra, your ultimate destination for convenient and efficient ride-sharing experiences. Yatra revolutionizes the way you travel, connecting riders and drivers seamlessly through a cutting-edge platform designed to enhance your journeys. Yatra is more than a ride; it's an adventure, a connection, and a step towards a greener future. Our platform boasts a user-friendly interface that allows you to effortlessly book rides with a few taps on your smartphone. Whether you're headed to work, meeting friends, or exploring the city, Yatra ensures you'll always find a reliable and comfortable ride at your fingertips.

Built With

Features

• [x] Map integration
• [x] Verify & upload License
• [x] View all users as admin
• [x] Draggable marker
• [x] Edit user status
• [x] Edit profile
• [x] Larger map
• [x] Change password
• [x] multi user login-> admin, user and rider
• [ ] bookmark -> location
• [x] price bargaining
• [x] multiple vehicle option
• [ ] easy switch between rider and user*
• [ ] real time notification
• [ ] tipping system*
• [ ] 30 sec timer
• [ ] view ride history*
• [ ] sort/multi sort

Roadmap

First Phase

• [x] Login
• [x] Register

Second Phase

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

(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

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/kaylinkhanal/yatra.git

2. Install NPM packages on both server and client

   cd server/
   npm install
   //wait for packages to install
   cd ..
   cd client/
   npm install

3. Add uploads folder in server

   cd server
   mkdir uploads
   cd uploads/
   mkdir licenseImage
   mkdir useAvatar
   

4. Run the project on both client and server

   npm run dev
   

5. Create .env file in server root (check .env.sample for reference)

   (back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(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 and wait for approval

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Name - @yatra - yatra@gmail.com

Project Link: https://github.com/kaylinkhanal/yatra

(back to top)