Home Parcel Tracking

This Project is made to give you a dashboard to trace your parcels running locally on your server. It uses publicly available APIs which are mostly undocumented to track the parcels. It then shows you in a simple Dashboard what your parcels are up to. Please read the steps below carefully.

runner

This is the API backend and runs on NodeJS. It does the tracking and managing of tracked parcels and could be used for alternative frontends or applications.

Requires node 12+

How to use

Installation

Clone the repository.
Get to the src folder.
Run npm run setup. Start the project runing npm run start. The server is now running on `http://localhost:3003/

Deamonize

You can also choose to create a SystemD module like in docs/systemd-sample.service. A run script is chosen since there was an issue with running NodeJS application directly through the SystemD module.

contributing

If you intend to contribute, please build your own up to date setup script for the frontend by running npm run creator in the runner/ folder. Please replace the old before opening a pull request. Also check out the modules tracking modules docs runner/tracking/docs.md

Opensource notice

This project uses several opensource projects. They need to be downloaded seperately with the help of the script for setting up the frontend.

Axios v0.27.2 by Matt Zabriskie Released under the MIT License
Vue.js v2.6.14 by Evan You Released under the MIT License
Bootstrap v3.4.1 by Twitter, Inc. Released under the MIT License

API Docs

The API docs are meant to help with developing alternative frontends and use Swagger UI Swagger UI by Viacheslav Lotsmanov Released under the MIT License