Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 2.69 KB

README.md

File metadata and controls

97 lines (71 loc) · 2.69 KB
Raw

RapidRoute

Welcome to RapidRoute - your go-to open-source delivery app designed for Hacktoberfest 2024! Built with cutting-edge technologies including React, Vite, MongoDB (Mongoose), Node.js, Tailwind CSS, and React Icons, this app aims to streamline the delivery process and enhance user experience.

Table of Contents

Features

  • User Authentication: Secure login and registration for users.
  • Real-Time Tracking: Monitor deliveries in real-time with live updates.
  • Order Management: Place, track, and manage orders seamlessly.
  • Admin Dashboard: Admin interface to manage users, orders, and deliveries.
  • Search Functionality: Quickly find items or services available for delivery.
  • Responsive Design: Optimized for both desktop and mobile devices.
  • Notification System: Get notified of delivery status changes.
  • Feedback System: Leave reviews and feedback for deliveries.

Technologies Used

  • Frontend:

    • React
    • Vite
    • Tailwind CSS
    • React Icons

  • Backend:

    • Node.js
    • Express.js
    • MongoDB (Mongoose)

  • Others:

    • Git
    • GitHub
    • NPM/Yarn

Getting Started

To get a local copy of RapidRoute up and running, follow these steps:

  1. Clone the repository

    git clone https://github.com/yourusername/rapidroute.git

  2. Navigate to the project directory

    cd rapidroute

  3. Install the required packages

    npm install
# or
yarn install

  4. Set up the environment variables

    • Create a .env file in the root directory and add your MongoDB connection string and other required environment variables.

  5. Start the development server

    npm run dev
# or
yarn dev

Contributing

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

To contribute:

  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

License

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

Acknowledgments

  • Thank you to the Hacktoberfest team for organizing this event.
  • A special thanks to the open-source community for your contributions and support!

We hope you enjoy using and contributing to RapidRoute! Let's make this a fantastic project together!