Skip to content

CamoRageaholic1/fiber-ops-dashboard

Repository files navigation

πŸš€ Fiber Ops Dashboard

License: CC BY-NC-SA 4.0 Docker Python 3.11 Flask

A comprehensive construction operations dashboard for fiber optic ISP projects with real-time Google Sheets integration, cost tracking, and productivity monitoring.

✨ Features

  • πŸ“Š Real-time Dashboard - Live metrics and project status updates
  • πŸ”„ Google Sheets Integration - Automatic data synchronization
  • πŸ’° Cost Tracking - Monitor material and labor expenses
  • πŸ“ˆ Progress Monitoring - Track footage completion across projects
  • 🐳 Docker Deployment - Easy setup with containerization
  • πŸ“± Mobile Responsive - Works on all devices
  • πŸ”’ Secure - Service account authentication
  • πŸ“ SQLite Database - Historical data storage

🎯 Quick Start

Prerequisites

  • Docker & Docker Compose
  • Google Cloud Service Account with Sheets API access
  • Google Sheet with project data

Installation

  1. Clone the repository
git clone https://github.com/CamoRageaholic1/fiber-ops-dashboard.git
cd fiber-ops-dashboard
  1. Run the installer (Ubuntu/Linux)
chmod +x scripts/install.sh
./scripts/install.sh
  1. Configure environment
# Edit .env with your settings
cp .env.example .env
nano .env
  1. Add Google credentials
# Place your service account JSON in credentials/
cp /path/to/your/credentials.json credentials/credentials.json
  1. Start the application
docker-compose up -d
  1. Access the dashboard
http://localhost:5000

πŸ“– Documentation

πŸ—οΈ Architecture

fiber-ops-dashboard/
β”œβ”€β”€ app/
β”‚   β”œβ”€β”€ app.py              # Flask application
β”‚   β”œβ”€β”€ requirements.txt    # Python dependencies
β”‚   └── templates/
β”‚       └── index.html      # Dashboard UI
β”œβ”€β”€ scripts/
β”‚   β”œβ”€β”€ install.sh          # Automated installer
β”‚   β”œβ”€β”€ start.sh            # Start script
β”‚   β”œβ”€β”€ stop.sh             # Stop script
β”‚   └── backup.sh           # Backup script
β”œβ”€β”€ docs/                   # Documentation
β”œβ”€β”€ Dockerfile
β”œβ”€β”€ docker-compose.yml
└── .env.example

πŸ”§ Configuration

Environment Variables

GOOGLE_SHEET_ID=your_sheet_id_here
FLASK_SECRET_KEY=your_secret_key_here
FLASK_ENV=production
PROJECT_NAME=Your-Project-Name

Google Sheets Format

Your Google Sheet should have these columns:

Project Name Total Footage Completed Footage Material Cost Labor Cost Total Cost Date

πŸ“Š API Endpoints

  • GET / - Main dashboard
  • GET /api/health - Health check
  • POST /api/sync - Trigger data sync
  • GET /api/stats - Get statistics
  • GET /api/projects - Get all projects
  • GET /api/history - Get sync history

πŸš€ Deployment

Docker Compose (Recommended)

docker-compose up -d

Manual Deployment

cd app
pip install -r requirements.txt
python app.py

πŸ› οΈ Development

Development Mode

docker-compose -f docker-compose.dev.yml up

Running Tests

# Tests coming soon

πŸ“ License

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

For Individual Use Only - Commercial use is prohibited.

See the LICENSE file for details.

🀝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details.

πŸ“§ Contact

πŸ™ Acknowledgments

  • Built with Flask and Bootstrap
  • Google Sheets API integration
  • Docker for containerization

⭐ If you find this project helpful, please star it!

About

A comprehensive construction operations dashboard for fiber optic ISP projects

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors