added readme
This commit is contained in:
parent
16e76a93de
commit
b542047398
112
README.md
112
README.md
@ -0,0 +1,112 @@
|
|||||||
|
# 🧾 DO Tracker & Manifest System
|
||||||
|
|
||||||
|
A lightweight Flask-based delivery order tracking and manifest system for inter-branch logistics. Built for internal use in multi-branch warehouse/distribution networks, such as plumbing or trade supply chains.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Features
|
||||||
|
|
||||||
|
- 🔐 Store-based login system (per-branch access control)
|
||||||
|
- 📦 Manual DO entry (DO Number + Delivery Number)
|
||||||
|
- 🚚 Track each DO across multiple store stopovers
|
||||||
|
- ✍️ Logs who handled the DO at each location
|
||||||
|
- 📅 Timestamps all arrivals and departures
|
||||||
|
- ✅ Final destination marking
|
||||||
|
- 🧼 Admin portal (WIP) for fixing errors
|
||||||
|
- 🔍 DO lookup by either DO Number or Delivery Number
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧱 Tech Stack
|
||||||
|
|
||||||
|
- Python 3
|
||||||
|
- Flask (Web Framework)
|
||||||
|
- SQLAlchemy (ORM)
|
||||||
|
- SQLite (default backend DB)
|
||||||
|
- Jinja2 (templating)
|
||||||
|
- PyCharm (dev environment)
|
||||||
|
- Gitea (self-hosted Git)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🗂 Folder Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
do-tracker/
|
||||||
|
├── app/
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── routes.py
|
||||||
|
│ ├── models.py
|
||||||
|
│ ├── auth.py
|
||||||
|
│ ├── templates/
|
||||||
|
│ └── static/
|
||||||
|
├── run.py
|
||||||
|
├── requirements.txt
|
||||||
|
├── README.md
|
||||||
|
└── do_tracker.db (generated after first run)
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🛠️ Setup Instructions
|
||||||
|
|
||||||
|
1. Clone repo:
|
||||||
|
```bash
|
||||||
|
git clone https://git.anubisdevelopments.com/buster_dylan/do-tracker.git
|
||||||
|
cd do-tracker
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create a Python virtual environment:
|
||||||
|
```bash
|
||||||
|
python -m venv venv
|
||||||
|
source venv/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Install dependencies:
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Initialize the database:
|
||||||
|
```bash
|
||||||
|
python
|
||||||
|
>>> from app import create_app, db
|
||||||
|
>>> app = create_app()
|
||||||
|
>>> app.app_context().push()
|
||||||
|
>>> db.create_all()
|
||||||
|
>>> exit()
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Run the app:
|
||||||
|
```bash
|
||||||
|
python run.py
|
||||||
|
```
|
||||||
|
|
||||||
|
Visit: [http://127.0.0.1:5000](http://127.0.0.1:5000)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✅ Login Details (Example)
|
||||||
|
|
||||||
|
| Store | ID | Password |
|
||||||
|
|----------------|-----|-----------|
|
||||||
|
| West Gosford | 210 | gosford |
|
||||||
|
| Woy Woy | 230 | woywoy |
|
||||||
|
| Charmhaven | 220 | charms |
|
||||||
|
| Long Jetty | 250 | jetty |
|
||||||
|
| RDD Erina | 240 | erina |
|
||||||
|
| Commercial | 610 | com610 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📌 TODO / Roadmap
|
||||||
|
|
||||||
|
- [ ] Admin panel to edit movements
|
||||||
|
- [ ] CSV export of DO logs
|
||||||
|
- [ ] Signature capture for deliveries
|
||||||
|
- [ ] Access logging & audit trail
|
||||||
|
- [ ] Move to Postgres for production
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Built by Dylan Wright for operational and portfolio use.
|
||||||
Loading…
x
Reference in New Issue
Block a user