README.md

Deliverly Frontend

A CodeCree project as part of the Knightshield Hackathon

Briefing: Create an app of any kind that utilizes the latest technolgy and has an innovative way of tracking packages and shipping!

Note: This project hasn't been fully completed due to the time constraints and the fact that we didn't start coding until the Wednesday due to other commitments.

About our project

• Project Name: Deliverly
• Short Project Description: An app to track drivers and packages
• Team Name: CodeCree
• Team Members: Max @maxtrewartha, Josh @joshheng
• Demo Link: https://staging.codecree.co.uk
• Repository Link: Deliverly Frontend and Deliverly Backend
• Labels: Single page web app (mobile friendly)

The pitch

Deliverly is an app to track drivers and packages as they travel accross routes between warehouses to their final destination. Operators (admins) can track the locations of all their drivers and manage both drivers and warehouses. Packages have a three word code which can be tracked by the customer in addition to a QR code used by the driver.

Highlights

Login Screen

Main UI

User Management

Updating user information

Warehouse Management

QR Code Generation

Route Manager

Code

Installation

1. Run npm install
2. Copy .env to .env.local and add empty fields

Running

1. Run npm start
2. Go to http://localhost:3000

Building

1. Run npm run build
2. Spawn a webserver in the build folder