WoPora Documentation

Welcome to the comprehensive documentation for WoPora, a modern workforce management platform designed for Australian businesses. WoPora provides complete time tracking, employee management, scheduling, and compliance features with full support for Australian award wages and employment regulations.

What is WoPora?

WoPora is a Next.js application that provides:

• Employee Management - Complete employee profiles with role assignments and location management
• Time Tracking - Clock in/out with photo capture, geofencing, and break management
• Scheduling & Rostering - Advanced scheduling with shift patterns and availability constraints
• Award Compliance - Australian award wage calculations with penalty rates and leave entitlements
• Device Management - Kiosk mode for shared devices with activation codes
• Analytics & Reporting - Comprehensive timesheet reports and dashboard analytics

Key Features

Modern Technology Stack

• Next.js 15 with App Router and React Server Components
• MongoDB with Mongoose ODM for data persistence
• TypeScript for type safety and better developer experience
• Tailwind CSS with shadcn/ui components for modern UI
• Cloudinary for image storage and management

Advanced Workforce Features

• Face Detection - Optional photo capture during clock in/out
• Geofencing - Location-based clock restrictions with soft/hard modes
• Offline Support - Works offline with automatic sync when connection returns
• Multi-tenant - Support for multiple employers and locations
• Role-based Access - Granular permissions for different user types

Australian Compliance

• Award Integration - Support for modern awards with penalty rates
• Break Rules - Automatic break calculations based on hours worked
• Leave Management - Annual leave, sick leave, and TOIL tracking
• Penalty Rates - Overtime, weekend, and public holiday calculations

Getting Started

Architecture Overview

WoPora follows a modern, scalable architecture:

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Frontend      │    │   API Routes    │    │   Database      │
│                 │    │                 │    │                 │
│ • Next.js 15    │◄──►│ • REST API      │◄──►│ • MongoDB       │
│ • React 18      │    │ • Validation    │    │ • Mongoose      │
│ • TypeScript    │    │ • Auth          │    │ • Indexes       │
│ • Tailwind CSS  │    │ • Rate Limiting │    │ • Aggregation   │
└─────────────────┘    └─────────────────┘    └─────────────────┘

Core Components

• Authentication - JWT-based auth with role-based permissions
• API Layer - RESTful API with OpenAPI documentation
• Data Models - Comprehensive schemas for all business entities
• File Storage - Cloudinary integration for photos and documents
• Real-time Updates - Live dashboard updates and notifications

Support & Community

• GitHub Repository - Source code and issue tracking
• API Documentation - Interactive OpenAPI/Swagger docs at /docs/api
• Developer Tools - Built-in debugging and development utilities

Ready to get started? Head over to the Installation Guide to set up your WoPora instance.