System Requirements Document (SRD)

Project Name: divine-employee

1. Introduction

The divine-employee project is an Employee Management System (EMS) designed to streamline employee-related operations for organizations in India. This web application will provide a robust platform for managing employees, departments, attendance, salaries, and leave requests, while ensuring security, scalability, and ease of use.

This document outlines the system requirements for the development of the divine-employee website, incorporating the features and functionalities requested by Ashish Sg. The system will cater to both administrators and employees, offering tailored interfaces and tools for each user persona.

2. System Overview

The divine-employee EMS will be a web-based application with the following objectives:

• Simplify employee management processes.
• Provide secure access to sensitive data like salaries and attendance records.
• Enable real-time attendance tracking and leave management.
• Offer analytics and reporting tools for administrators.
• Ensure scalability to accommodate organizations of varying sizes.

The system will consist of two primary user interfaces:

1. Admin Panel: For managing employees, departments, attendance, salaries, and generating reports.
2. Employee Panel: For employees to view and update their profiles, mark attendance, apply for leave, and access salary slips.

The website will be developed using modern technologies to ensure responsiveness, security, and performance.

3. Functional Requirements

Admin Panel

• As Admin, I should be able to log in and log out securely.
• As Admin, I should see a dashboard with total employees, departments, and attendance stats.
• As Admin, I should be able to add, edit, and delete employees.
• As Admin, I should be able to manage departments.
• As Admin, I should be able to assign roles and permissions to employees.
• As Admin, I should be able to manage salaries and generate salary slips.
• As Admin, I should be able to generate reports in PDF and Excel formats.

Employee Panel

• As Employee, I should be able to log in and log out securely.
• As Employee, I should be able to view my profile and update my details.
• As Employee, I should be able to mark attendance (Check-in / Check-out).
• As Employee, I should be able to apply for leave.
• As Employee, I should be able to view my leave history.
• As Employee, I should be able to view my salary slips.

Attendance System

• As Admin, I should be able to track daily attendance.
• As Admin, I should be able to detect late arrivals and half-days.
• As Admin, I should be able to generate monthly attendance reports.

Leave Management

• As Employee, I should be able to apply for leave.
• As Admin, I should be able to approve or reject leave requests.
• As Employee, I should be able to view my leave history.

UI/UX

• As User, I should experience a modern responsive design.
• As User, I should navigate the website easily using a sidebar navigation menu.
• As Admin, I should see dashboard analytics charts for quick insights.

Security

• As User, I should have secure authentication using JWT.
• As User, I should have my password hashed for security.
• As Admin, I should be able to enforce role-based access control.

Additional Features

• As Admin, I should be able to search and filter employees.
• As User, I should receive notifications for important updates.
• As Admin, I should be able to export data to Excel and PDF formats.

4. User Personas

Admin

• Role: Organization manager or HR personnel.
• Responsibilities: Manage employees, departments, attendance, salaries, and leave requests.

Employee

• Role: Organization staff member.
• Responsibilities: Update profile, mark attendance, apply for leave, and view salary slips.

5. Visuals Colors and Theme

Color Palette

The divine-employee website will feature a professional yet vibrant color scheme to reflect its modern and efficient identity:

• Background: #F5F5F5 (Light Gray)
• Surface: #FFFFFF (White)
• Text: #333333 (Dark Charcoal)
• Accent: #007BFF (Bright Blue)
• Muted Tones: #B0BEC5 (Soft Steel Gray)

6. Signature Design Concept

Home Page Design: Interactive Dashboard with Animated Analytics

The homepage of the divine-employee website will feature an interactive dashboard that dynamically updates analytics charts and stats based on real-time data.

Key Features:

1. Animated Charts: Pie charts, bar graphs, and line charts will animate as data loads, providing a visually engaging experience.
2. Hover Interactions: Hovering over charts will display detailed tooltips with additional data insights.
3. Dynamic Widgets: Widgets for attendance, departments, and salaries will update in real-time, giving users a sense of immediacy.
4. Background Animation: A subtle gradient animation will flow across the background, creating a modern and polished look.
5. Micro-Interactions: Buttons and icons will have smooth hover effects and transitions, enhancing the user experience.

This design will make the website feel alive and responsive, leaving a lasting impression on users.

7. Non-Functional Requirements

• The system should support at least 500 concurrent users.
• The website should load within 3 seconds for optimal performance.
• The system should comply with GDPR and Indian data protection laws.
• The database should be optimized for scalability and reliability.

8. Tech Stack

Frontend

• React for Web

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

AI Tools

• GPT 5.4 for user-friendly responses

Local Orchestration

• Docker
• docker-compose

Server-Side Orchestration

• Kubernetes

9. Assumptions and Constraints

Assumptions

• Users will have access to modern browsers like Chrome, Firefox, or Edge.
• The system will primarily cater to organizations in India.

Constraints

• The system must be compatible with mobile and desktop devices.
• The database must handle sensitive data securely.

10. Glossary

• EMS: Employee Management System.
• JWT: JSON Web Token, used for secure authentication.
• GDPR: General Data Protection Regulation, a data protection law.
• UI/UX: User Interface/User Experience.
• API: Application Programming Interface.