Skip to content

ShanthanosJr/WFS-ENG

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Workflows Engineering

Smart Construction Workflow & Safety Management System (SCWMS)

License: MIT Node.js MongoDB

A comprehensive construction management platform with modular architecture for workflow optimization and safety compliance.

πŸ“‹ Table of Contents

πŸ“– About

SCWMS is a modern, full-stack construction management system designed to streamline construction project workflows, enhance safety protocols, and provide real-time insights through advanced analytics. Built with React, Node.js, and MongoDB, it offers a unified interface to manage all aspects of construction projects.

✨ Key Features

  • Worker Safety Management - Attendance tracking, safety incidents, and training records
  • Equipment Tracking - Rental management, maintenance schedules, and condition monitoring
  • Compliance Monitoring - Automated inspection scheduling and compliance reporting
  • Material Management - Inventory tracking and supplier performance metrics
  • Financial Dashboard - Project timelines, budget monitoring, and financial reporting
  • Real-time Analytics - Interactive dashboards with data visualization
  • QR Code Integration - For attendance and equipment tracking

πŸ“¦ Modules

  1. WSPM - Worker Safety & Payroll Management
  2. ETM - Equipment Tracking Management
  3. CIM - Compliance & Inspection Management
  4. MISTM - Materials & Suppliers Tracking Management
  5. PTFD - Projects Timeline & Financial Dashboard

πŸ› οΈ Tech Stack

Frontend

  • React.js with Create React App
  • React Router for navigation
  • Bootstrap 5 for responsive UI
  • Chart.js and Recharts for data visualization
  • Axios for API communication

Backend

  • Node.js with Express.js
  • MongoDB with Mongoose ODM
  • JWT for authentication
  • Nodemailer for email notifications

πŸš€ Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm (v6 or higher)
  • MongoDB (local instance or cloud connection)

Installation

  1. Clone the repository

    git clone https://github.com/ShanthanosJr/WFS-ENG.git
    cd WFS-ENG
  2. Install dependencies

    # Make scripts executable
    chmod +x setup.sh setup-env.sh start.sh
    
    # Install all dependencies
    ./setup.sh
    
    # Set up environment variables
    ./setup-env.sh
  3. Configure environment variables Update the .env files in each backend directory with your specific configurations.

  4. Start the application

    ./start.sh

Manual Installation (Alternative)

If you prefer to set up services manually:

# Install root dependencies
npm install

# Install frontend dependencies
cd client && npm install && cd ..

# Install backend dependencies for each module
cd WSPM/backend && npm install && cd ../..
cd ETM/backend && npm install && cd ../..
cd CIM/backend && npm install && cd ../..
cd MISTM/Backend && npm install && cd ../..
cd PTFD/Backend && npm install && cd ../..

▢️ Running the Application

All Services

npm start

Individual Services

# Frontend (http://localhost:3000)
cd client && npm start

# WSPM Backend (http://localhost:5001)
cd WSPM/backend && npm start

# ETM Backend (http://localhost:5002)
cd ETM/backend && npm run dev

# CIM Backend (http://localhost:5003)
cd CIM/backend && npm start

# MISTM Backend (http://localhost:5004)
cd MISTM/Backend && npm start

# PTFD Backend (http://localhost:5050)
cd PTFD/Backend && npm start

πŸ“ Project Structure

WFS-ENG/
β”œβ”€β”€ client/                 # Unified React frontend (port 3000)
β”œβ”€β”€ WSPM/                   
β”‚   └── backend/            # Worker Safety & Payroll Management (port 5001)
β”œβ”€β”€ ETM/                    
β”‚   └── backend/            # Equipment Tracking Management (port 5002)
β”œβ”€β”€ CIM/                    
β”‚   └── backend/            # Compliance & Inspection Management (port 5003)
β”œβ”€β”€ MISTM/                  
β”‚   └── Backend/            # Materials & Suppliers Tracking (port 5004)
β”œβ”€β”€ PTFD/                   
β”‚   └── Backend/            # Projects Timeline & Financial Dashboard (port 5050)
β”œβ”€β”€ package.json            # Root package with concurrently script
└── *.sh                    # Setup and utility scripts

🌐 API Endpoints

  • WSPM API: http://localhost:5001/api/
  • ETM API: http://localhost:5002/api/
  • CIM API: http://localhost:5003/api/
  • MISTM API: http://localhost:5004/api/
  • PTFD API: http://localhost:5050/

🀝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

See CONTRIBUTING.md for more detailed information.

πŸ“„ License

Distributed under the MIT License. See LICENSE for more information.

πŸ‘₯ Contact

Project Link: https://github.com/ShanthanosJr/WFS-ENG

About

WFS-ENG is an advanced engineering workflows platform that integrates multiple specialized modules for comprehensive project management, financial tracking, and operational efficiency in construction and engineering projects.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors