Badoc Document Routing System

Web-based document routing and communication tracking system for the Municipality of Badoc Mayor's Office.

Status: Prototype for pilot evaluation. This repository is private and is not yet an official production deployment.

Purpose

The system helps the office record incoming communications, route them through the appropriate office stage, and maintain an accountable routing history from receipt through release.

Key features

• Secure staff login and administrator-managed staff accounts
• Automatic routing assignments by status
• Status stages for Received, For Review, With Mayor, For Checking, For Release, Released, and Returned
• Color-coded dashboard and printable communications register
• Control-number suggestions based on the latest record
• Required remarks for returned communications
• Release correction through an auditable Undo Release action
• Reversible record archiving and restoration
• Pagination, filtering, and communication search

Technology

• Laravel 13
• PHP 8.5
• Blade templates and custom CSS
• SQLite for local development; MySQL or PostgreSQL recommended for production

Local setup

cd src
composer install
cp .env.example .env
php artisan key:generate
php artisan migrate
php artisan serve

Before running a fresh database seed, set a secure INITIAL_ADMIN_PASSWORD in your local .env file. Never commit .env files, passwords, API keys, or real office records.

Demo

A separate fictional-data demonstration setup is available in src/docs/DEMO.md. It must never be used with real office communications.

Deployment

Production deployment, backup, and security requirements are documented in src/docs/DEPLOYMENT.md. Official deployment requires approval, municipal ownership of hosting accounts, and proper procurement.

Security and data handling

• Do not store real records in public demos.
• Use a private repository and official municipal accounts for production services.
• Use archive and restore rather than permanent deletion of office records.
• Report security concerns privately as described in SECURITY.md.

Ownership

Proprietary — Municipality of Badoc. All rights reserved. No public reuse, redistribution, or production deployment is authorized without approval from the Municipality of Badoc.