Skip to content

AuralenX/NetisTrackGh

Repository files navigation

NetisTrackGh Logo

NetisTrackGh

Comprehensive Site Monitoring & Management System

Docs Index Swagger Docs License: MIT Visit Link


Typing SVG


📌 About NetisTrackGh

NetisTrackGh is a robust site monitoring and management system built to simplify operations for telecommunication sites.
It tracks fuel consumption, schedules maintenance, logs activities, and provides role-based dashboards for admins, supervisors, and technicians.


🚀 Features

  • Real-time monitoring: Track generator status and fuel levels in real time
  • Role-based access: Admin, supervisor, and technician dashboards
  • Maintenance scheduling: Automatic reminders and logging
  • Offline support: Works even when internet connection is unstable
  • Activity logs & security tracking
  • Authentication & user management via Firebase and backend JWT

🛠️ Tech Stack

Layer Technology
Frontend HTML, CSS, JavaScript
Backend Node.js, Express.js
Database Firebase Firestore
Authentication Firebase Auth + JWT
Hosting Vercel (Backend API) + static hosting for SPA

🔗 Quick Links

GitHub Repo Live Demo Report Issue


📚 Documentation

  • Documentation Index: documentation/README.md
  • Requirements & Use Cases: documentation/requirements.md
  • Architecture Overview: documentation/architecture.md
  • Local Development Setup: documentation/setup.md
  • Deployment Guide: documentation/deployment.md
  • Security Model: documentation/security.md
  • Testing Strategy: documentation/testing.md
  • API Reference: documentation/api/endpoints.md
  • Database Schema (Firestore): documentation/database/schema.md
  • UI/UX Guide: documentation/ui/ui-guide.md
  • Offline & Sync Strategy: documentation/offline.md
  • Environment Configuration: documentation/environment.md
  • Contributing Guide: documentation/contributing.md
  • Changelog: documentation/changelog.md
  • Swagger (Live API Docs): http://localhost:3000/docs

🧭 Getting Started

  • Local Setup: see documentation/setup.md for prerequisites, environment variables, and run commands.
  • API Reference: see documentation/api/endpoints.md and live Swagger at http://localhost:3000/docs.
  • Architecture Overview: documentation/architecture.md.
  • Security and Testing: documentation/security.md and documentation/testing.md.

🧩 Project Structure

  • backend/: Node.js + Express API, Firebase Admin, Swagger at /docs
  • frontend/: Static SPA (Vanilla JS), PWA manifest, components/pages/services
  • documentation/: Full project docs

👥 Roles & Permissions

Technician View assigned sites, log fuel/maintenance, view own reports Supervisor View all sites, verify logs, view analytics, manage technicians Admin Full system access, user/site management, configuration, data export

📝 License

MIT License © Auralenx

Made with ❤️ by AuralenX

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors