Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

838 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation


๐ŸŒŸ About WorkSync

WorkSync is an Enterprise Office Management System built for high performance software engineering internship offices and development teams. It unifies project management, task tracking, Kanban workflows, employee attendance, AI assisted prompt generation, approval inboxes, activity audit trails, and team collaboration into a single, intuitive workspace.

๐Ÿš€ Designed and developed based on the Office Management System Software Design and Functional Specification Version 3.0, WorkSync replaces scattered spreadsheets, manual attendance sheets, informal task assignments, and disconnected notes with an enterprise ready platform.

๐ŸŽฏ Key Highlights
๐Ÿ” Granular RBAC Permissions ๐Ÿ“‹ Interactive Kanban Board ๐Ÿค– AI Prompt Builder Assistant
โฐ Attendance and Leave Inbox ๐Ÿ“… Google Classroom Style Calendar ๐Ÿ“ˆ Reports and Workload Analytics
๐Ÿ’ฌ Tasks with Embedded Chatbox ๐Ÿ”” Real Time Notification Routing ๐Ÿ“œ Full System Audit Activity Log

๐Ÿš€ Live Demo

๐ŸŒ View Live Application

GitHub Repository


๐Ÿ‘ฅ Team & Work Distribution

Our project was built through a dedicated modular distribution where each team member took ownership of core application modules:

Team Status
No. ๐Ÿง‘โ€๐Ÿ’ป Team Member ๐Ÿ™ GitHub Profile ๐ŸŽฏ Assigned Module ๐Ÿ“Š Status
01 Salman Ahmed @Salman-ahmed-2 ๐Ÿ–ฅ๏ธ Dashboard + Repo Setup โœ… Completed
02 Taha Sohail @TahaSohail-Goat ๐Ÿ”‘ Login + Activity Log โœ… Completed
03 Maryam @meowryam ๐Ÿ“ˆ Reports + Profile โœ… Completed
04 Inshrah Mumtaz @inshrahmumtaz โฐ Attendance + Approval Inbox โœ… Completed
05 Laiba Inqilab @laibainqilab-ds ๐Ÿ“ Projects + Calendar โœ… Completed
06 Bilal Mughal @Bilalmughal-07 ๐Ÿ“‹ Notifications + Kanban โœ… Completed
07 Hassaan Ahmed @hassaanahmed-dev ๐Ÿ‘ฅ Members + AI Assistant โœ… Completed
08 Abiha Jibran @abihajibbran1-lang โœ… Tasks + Chatbox โœ… Completed
09 Abdul Azeem Hashmi @AbdulAzeemHashmi ๐Ÿ“– Readme.md โœ… Completed

๐Ÿ† Core Modules & Feature Breakdown

1๏ธโƒฃ ๐Ÿ–ฅ๏ธ Dashboard & Repository Setup (Salman Ahmed)

Lead Developer: @Salman-ahmed-2

  • ๐Ÿ  Central Workspace Hub: Provides immediate visibility into active work, upcoming deadlines, pending items, and quick system actions.
  • โš™๏ธ Project Repository Architecture: Built the initial foundation, build pipeline, Vite configuration, and reusable frontend modular structure.
  • ๐Ÿ“Š Role Sensitive Summary Cards: Displays personal metrics for Team Members, team progress for Managers, and system oversight for Administrators.
  • โšก Quick Action Buttons: Dynamic role-based action triggers for fast task creation, project initialization, and attendance check-in.
  • ๐Ÿ”” Compact Calendar & Notification Preview: Integrated quick view panels for active calendar events and recent system alerts.
2๏ธโƒฃ ๐Ÿ”‘ Login & Activity Log (Taha Sohail)

Lead Developer: @TahaSohail-Goat

  • ๐Ÿ”’ Authentication & Session Handling: Secure sign-in workflow supporting Admin, Manager, Team Member, Team Lead, and HR roles.
  • ๐Ÿ“œ System Audit Trail: Complete activity logging capturing actor, action type, entity target, old/new field values, and timestamps.
  • ๐Ÿ” Activity Search & Filtering: Filter logs by actor, project context, entity type, date range, and approval status.
  • ๐Ÿ›ก๏ธ Security Safeguards: Ensures sensitive values like passwords, tokens, or secret keys are never exposed in log entries.
  • ๐Ÿ“… Chronological Grouping: Organizes log records cleanly into Today, Yesterday, and historical date blocks.
3๏ธโƒฃ ๐Ÿ“ Projects & Calendar (Laiba Inqilab)

Lead Developer: @laibainqilab-ds

  • ๐Ÿ“ Project Management Center: Complete project overview with status indicators, manager ownership, start/end dates, and progress meters.
  • ๐Ÿ“… Google Classroom Inspired Calendar: Full Month, Week, Day, and Agenda schedule views showing task deadlines, project milestones, and meetings.
  • ๐ŸŽฏ Milestones & Dependencies: Define project milestones, task dependencies, and project scope members.
  • ๐Ÿ—„๏ธ Project Archival Workflow: Archive completed or inactive projects while keeping historical records intact and viewable.
  • ๐ŸŽจ Visual Event Categorization: Visually distinguishable calendar events by type without relying solely on color indicators.
4๏ธโƒฃ โœ… Tasks & Chatbox (Abiha Jibran)

Lead Developer: @abihajibbran1-lang

  • ๐Ÿ“ Task Management Hub: Combined task listing, detail inspection, subtasks, circular dependency prevention, and priority tracking.
  • ๐Ÿ’ฌ Embedded Task Chatbox: Built asynchronous discussion threads with @mentions, rich comments, and blocker assistance requests.
  • ๐Ÿ“Ž File & Attachment Support: Secure attachment upload for task specifications, design mocks, and completion evidence.
  • ๐Ÿšง Blocker Reporting: Mandatory blocker reason entry when transitioning tasks into Blocked status.
  • ๐Ÿ”’ Controlled Task Edits: Protects task changes (due date, priority, assignee) by routing updates through approval rules.
5๏ธโƒฃ ๐Ÿ“‹ Notifications & Kanban Board (Bilal Mughal)

Lead Developer: @Bilalmughal-07

  • ๐ŸŽฏ Interactive Kanban Board: Visual workflow board for dragging and dropping tasks across Todo, In Progress, Review, Done, and Blocked stages.
  • ๐Ÿ”” Real Time Notification Inbox: Category filtered alert center tracking assignments, deadline warnings, mentions, and approval outcomes.
  • โ™ฟ Accessible Inline Status Toggles: Keyboard and accessible status transition controls for screen readers and quick adjustments.
  • ๐ŸŽฏ Smart Kanban Filters: Filter board tasks by project, assignee, priority, overdue status, or personal assignments.
  • ๐Ÿš€ Stage Transition Rules: Enforces mandatory work summaries when submitting tasks to Review or Done.
6๏ธโƒฃ ๐Ÿ“ˆ Reports & Profile (Maryam)

Lead Developer: @meowryam

  • ๐Ÿ“Š Operational Reports Suite: Summarizes project progress, overdue task counts, member workloads, and project health indicators using Recharts.
  • ๐Ÿ“ค Multi Format Export: Export reports directly to CSV and print ready formats.
  • ๐Ÿ‘ค Personal Profile Center: User workspace displaying personal assigned tasks, project memberships, attendance logs, and personal activity.
  • ๐Ÿท๏ธ Designation & Department Management: Profile details editor covering job titles, departments, profile avatars, and notification preferences.
  • ๐Ÿ” Scoped Data Visibility: Ensures members see personal reports, managers see team/project analytics, and admins see organization metrics.
7๏ธโƒฃ โฐ Attendance & Approval Inbox (Inshrah Mumtaz)

Lead Developer: @inshrahmumtaz

  • โฐ Daily Attendance System: One click check-in, check-out, working hours calculation, late check-in, and early departure tracking.
  • ๐Ÿ“ฅ Pending Approval Inbox: Dedicated queue for reviewing controlled task edit proposals, leave requests, and attendance corrections.
  • ๐Ÿ–๏ธ Leave Request Workflow: Submit and process leave requests with date range pickers, supporting documents, and decision notes.
  • ๐Ÿ›ก๏ธ Temporary HR Permissions: Restricts attendance and leave approval powers exclusively to users holding active HR assignments.
  • ๐Ÿšซ Validation Enforcements: Prevents check-out before check-in, duplicate check-ins, or overlapping leave request windows.
8๏ธโƒฃ ๐Ÿ‘ฅ Members & AI Assistant / Prompt Builder (Hassaan Ahmed)

Lead Developer: @hassaanahmed-dev

  • ๐Ÿ‘ฅ Team Member Directory: Searchable team member roster with grid/table views, department filters, and profile details.
  • ๐Ÿค– AI Prompt Builder: Converts real project and task context into structured AI prompts for breakdowns, acceptance criteria, test cases, and code reviews.
  • ๐Ÿ“‘ Prompt Customization: Request beginner-friendly, technical, checklist, or step-by-step versions of generated prompts.
  • ๐Ÿ›ก๏ธ AI Safety & Privacy Filters: Prevents secret API keys, passwords, or system configurations from being injected into AI prompts.
  • ๐Ÿ’พ Drafts & Generation History: Save, copy, and reuse generated AI prompt outputs.
9๏ธโƒฃ ๐Ÿ“– Complete Documentation & README (Abdul Azeem Hashmi)

Lead Developer: @AbdulAzeemHashmi

  • ๐Ÿ“– Comprehensive Project README: Created full technical documentation, team contribution matrix, system specifications, and getting started guide.
  • ๐Ÿ“ System Specification Mapping: Documented functional requirements (FR-001 through FR-020), validation rules, non-functional requirements, and RBAC matrix.
  • ๐ŸŽจ Visual Aesthetics & Banners: Designed animated header banners, shield badges, typing SVGs, and formatted module breakdown views.
  • ๐Ÿ“œ Clean Formatting Standards: Standardized documentation layout without prohibited special dash characters.

๐Ÿ” Roles, Permissions & Approval Hierarchy

WorkSync implements a dual layer permission model comprising permanent system roles and temporary project/functional delegations:

                  +-----------------------+
                  |     Administrator     |
                  +-----------+-----------+
                              |
                              v
                  +-----------------------+
                  |        Manager        |
                  +-----------+-----------+
                              |
                              v
                  +-----------------------+
                  |      Team Member      |
                  +-----+-----------+-----+
                        |           |
       +----------------+           +----------------+
       |                                             |
       v                                             v
+-------------------------------+   +-------------------------------+
| Temporary Team Lead (Project) |   |    Temporary HR (Attendance)  |
+-------------------------------+   +-------------------------------+

๐Ÿ‘ฅ System Roles Summary

Role Scope Key Capabilities
๐Ÿ‘‘ Administrator Global System User account creation, manager access grants, system security settings, global activity audit log.
๐Ÿ‘” Manager Office / Projects Project & task creation, member assignment, temporary Team Lead & HR delegations, project progress approval.
๐Ÿง‘โ€๐Ÿ’ป Team Member Assigned Scope Task execution, Kanban status movement, task comments, check-in/out, leave requests, Prompt Builder access.
๐Ÿ›ก๏ธ Temporary Team Lead Project Scoped Review & approve controlled task field edits (deadlines, priority, assignees) for assigned projects.
๐Ÿ“‹ Temporary HR HR Functions Review & approve attendance corrections, leave requests, and attendance report viewing.

๐Ÿ“‹ System-wide Functional Requirements

The following core requirements govern system behavior (derived from Software Specification v3.0):

ID Functional Requirement Description
FR-001 All authenticated users shall be able to view all active projects and tasks.
FR-002 The system shall restrict task edits to authorized Managers, assigned Team Members, and applicable temporary Team Leads.
FR-003 Every record list shall provide search, filtering, and sorting appropriate to that module.
FR-004 Filters shall combine using AND logic unless the interface clearly states otherwise.
FR-005 The system shall preserve the current filter state while the user opens and closes detail panels.
FR-006 Dashboard cards shall navigate to the matching filtered module.
FR-007 Every important create, edit, archive, delete, assignment, approval, and status change shall create an Activity Log entry.
FR-008 The system shall support comments on projects and tasks.
FR-009 The system shall support file and image attachments on projects, tasks, and comments.
FR-010 The system shall display upload progress, success, failure, and retry states.
FR-011 The system shall prevent duplicate submissions caused by repeated clicks.
FR-012 The system shall support temporary Team Lead and HR assignments with scope and optional expiry.
FR-013 Attendance approval notifications shall be sent only to users with active HR permission.
FR-014 The Prompt Builder shall use selected project and task data as context.
FR-015 Generated AI content shall remain editable and shall not directly change system records without user review.
FR-016 All date and permission validation shall be enforced server side.
FR-017 The system shall provide clear success, warning, and error messages.
FR-018 Archived records shall remain available for viewing and reporting.
FR-019 Destructive actions shall require user confirmation.
FR-020 The system shall support responsive desktop, tablet, and mobile layouts.

๐Ÿ’ป Tech Stack

WorkSync leverages a modern, reliable full stack TypeScript architecture:

Layer Technology Purpose
Frontend Framework React 19 + Vite 6 Lightning fast SPA client application rendering
Language TypeScript 5.8 Full end to end type safety and reliable code contracts
Styling & UI Tailwind CSS v4 Modern responsive styling & glassmorphism components
Icons & Motion Lucide React + Motion Elegant SVG icons & fluid UI micro animations
Charts Recharts 3 Responsive interactive analytics & workload visualizations
Backend Runtime Node.js + Express 4 RESTful API routes, authentication middleware & business rules
Database PostgreSQL 16+ / Supabase Relational data persistence & 3NF database model
Document Generation PDFKit Server-side PDF export generation for reports
Deployment Vercel Production web hosting & automated CI/CD deployment

โšก Getting Started

Follow these steps to run WorkSync locally on your machine.

๐Ÿ“‹ Prerequisites

  • Node.js: v18.0.0 or higher
  • npm or bun package manager
  • PostgreSQL: Local instance or Supabase connection string

๐Ÿ”ง Installation & Setup

  1. Clone the Repository

    git clone https://github.com/CODOC-IT/worksync.git
    cd worksync
  2. Install Dependencies

    npm install
  3. Configure Environment Variables Create a .env file in the root directory:

    PORT=3000
    DATABASE_URL=postgresql://user:password@localhost:5432/worksync
    JWT_SECRET=your_jwt_secret_key_here
    VITE_API_URL=http://localhost:3000
  4. Run Development Mode Start both the frontend development server and backend service:

    # Start frontend app (Vite)
    npm run dev
    
    # In a separate terminal, start backend API server
    npm run server
  5. Open in Browser Navigate to http://localhost:3000 to interact with WorkSync.

  6. Run Test Suites

    npm run test:accounts

๐Ÿ“ Repository Structure

worksync/
โ”œโ”€โ”€ api/                   # Vercel serverless entry points
โ”œโ”€โ”€ backend/               # Express backend API & domain services
โ”‚   โ””โ”€โ”€ src/
โ”‚       โ”œโ”€โ”€ accounts/      # User accounts & RBAC logic
โ”‚       โ”œโ”€โ”€ database/      # PostgreSQL client & queries
โ”‚       โ””โ”€โ”€ server.ts      # Express server initialization
โ”œโ”€โ”€ database/              # SQL migrations & 3NF schemas
โ”œโ”€โ”€ docs/                  # Software specifications & design documents
โ”œโ”€โ”€ frontend/              # Vite + React 19 frontend codebase
โ”‚   โ””โ”€โ”€ src/
โ”‚       โ”œโ”€โ”€ components/    # Reusable glassmorphism UI components
โ”‚       โ”œโ”€โ”€ features/      # Feature modules (Kanban, Attendance, Reports, etc.)
โ”‚       โ””โ”€โ”€ pages/         # Application view routes
โ”œโ”€โ”€ package.json           # Scripts & project dependencies
โ”œโ”€โ”€ tsconfig.json          # TypeScript compiler configuration
โ””โ”€โ”€ vite.config.ts         # Vite bundler configuration

๐Ÿ”ฎ Future Enhancements

As defined in Section 23 of the functional specification, future iterations of WorkSync will incorporate:

  • ๐Ÿ’ฌ Real Time Team Chat: Direct messaging and channels for instant team communication.
  • ๐Ÿ“ฑ Native Mobile Application: iOS and Android mobile apps for attendance and task management.
  • ๐Ÿ”” Email & Push Notifications: External email summaries and browser push notifications.
  • ๐Ÿ“… Third Party Calendar Sync: Two way sync with Google Calendar and Microsoft Outlook.
  • ๐Ÿ”— GitHub Repository Integration: Link pull requests and commits directly to tasks.
  • ๐Ÿค– Advanced AI Analytics: Workload prediction and task complexity estimation.

WorkSync Office Management System โ€ข Built with โค๏ธ by the Intern Engineering Team

Vercel GitHub

About

Browser-based office management system for tracking projects, tasks, attendance, and team activity with built-in AI assistance for prompts, summaries, and PR/issue drafting.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages