/DeliverEase

A prototype delivery routing system using A* search algorithm

Primary LanguageJavaScriptMIT LicenseMIT


Logo

DeliverEase

Your Commuting Buddy
Explore the paper »

View Demo · Report Bug · Request Feature

Demo

0704.mp4

About The Project

DeliverEase is an innovative prototype routing system designed to streamline route planning for delivery riders. This system optimizes delivery routes to save time, reduce fuel consumption, and enhance efficiency, making the delivery process smoother and more reliable.

Table Of Contents

  1. About The Project
  2. Application Snapshots
  3. Installation
  4. Run
  5. Contributors
  6. License

Features

  • Landing page with user input
  • Interactive 3D landing page with a "View App" button
  • User-friendly routing page with input fields and dynamic route display
  • Map page showcasing delivery addresses
  • Comprehensive delivery management with add, delete, optimize, and reset functions
  • Satellite view for enhanced map visualization
  • Efficient routing system powered by the A* algorithm
  • Automatic map panning and zoom in/out functionality

Technologies

DeliverEase utilizes a variety of technologies to ensure smooth and efficient operation:

  • React: A JavaScript library for building user interfaces.
  • Vite: A build tool that aims to provide a faster and leaner development experience for modern web projects.
  • Tailwind CSS: A utility-first CSS framework for rapidly building custom designs.
  • JavaScript: The programming language used for client-side scripting.
  • API Integration: Used for connecting to various external services.
  • Three.js: A JavaScript library used to create and display animated 3D graphics.
  • Framer Motion: A library for creating animations in React.
  • React Three Fiber: A React renderer for Three.js.

Application Snapshots

Landing Page

Landing Page

Maps Page

Maps Page1 Maps Page2 Maps Page3 Maps Page4 Maps Page5

Getting Started

DeliverEase is not yet accessible to the World Wide Web, as it is yet to be deployed. However, if you're interested in seeing the UI and experiencing the website yourself, you are in the right section of the README. To get started with accessing the source code, follow the steps below.

Prerequisites

Ensure that Node.js and npm are installed on your machine.

Installation

You can fork this repository, or you can also clone this repository directly on your local machine:

git clone https://github.com/your-username/deliverease.git

After cloning the repository on your local machine, access it on any IDE.

After opening the project, you should see all the files listed in the folder structure, but without the .env file for the server-side code.

Install dependencies using:

npm install

Create a .env file in the server folder and configure it as needed.

Configure the database connection in server/config/db.js as per your environment.

Run the server on /server:

node server.js

Run

To run DeliverEase, open your terminal and execute the following command:

npm run dev

Contributor's Table

Name Avatar GitHub Contributions
Regina Bonifacio Feiryrej Frontend Developer, User Interface Design, Map styling
Kyla Morcillos Akzechkyla Lead Developer, Implemented A* Algorithm
Franz De Villa DotBisch Server-side Developer, Fetched deliveries data

License

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

[Back to top]