Kaz Delivery Management System

A Kaz delivery management system provides basis functional for a delivery company

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Contact
6. Acknowledgments

About The Project

This project is actually for my prepration thesis from Can Tho University. This is a management system for a delivery company. There are a lot of fundamental functionalities that implemented in order for a delivey company to manage their orders.

Here are some of the basis required feature:

• Orders Management (status, date created, ...)

• Statiscal and Financial Report 💲

• Order tracking 🚚 (implement Leaflet Routing Machine)

Although the application is mainly built just for a manager of the company to manage the orders. I also built some additional functionalities for customers to use the system and a mobile version for the drivers of the company to demonstrate how the tracking order's location functionality work. Here's a brief look of the mobile version 📱:

(back to top)

Built With

For front end (including Mobile)

• Vue.js v2
• Quasar.js v1

For the backend API

• Python
• Django
• Django Rest Framework

(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

For the web application to work, you only need to focus on the backend and the shipping-system folder.

Installation

1. Clone the repo and change to that folder

   git clone https://github.com/NgoQuocBao1010/Shipping-System-Management.git

2. Install packages for the backend

   • Change folder to backend folder

     cd backend
     
     pip install -r requirements.txt

   • Create certificate for Django to update Django localhost to HTTPS: Follow this instruction. (You can take a look at my folder for reference)

   • Run the HTTPS server

       cd src
     
       python manage.py runserver_plus --cert-file cert.pem --key-file key.pem

3. Install packages for the frontend

   • Change folder to shippping-system and install packages via npm

     cd shipping-system
     
     npm install

   • Get a free API Key for OpenRouteService (API for calculating distance between 2 locations) at their website.

   • Update the API in "./shipping-system/src/api/routing/location.js"

     const OPENSERVICE_API_KEY =
     "YOUR_API_KEY";

   • Run the frontend server

     npm run serve

(back to top)

Usage

As the introduction indicated, the main purpose of this project is for delivery management, after the installation successfully, you can exploring around the application to enjoy all of its functionalities.

(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

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Ngô Hồng Quốc Bảo - @NgoQuocBao

Project Link: https://github.com/NgoQuocBao1010/Shipping-System-Management

(back to top)

Acknowledgments

This awesome README temaplate is from Best README Template. ♥

(back to top)