It helps track your contributions and performance in an organization. Create and manage them through the dashboard for efficient monitoring and evaluation.
To get started with the WorkLog Tracker, follow these steps:
-
Clone the Repository:
-
Upload to Hosting Server: Upload the cloned repository to your hosting server.
-
PHP Version: Ensure that your server supports PHP 7.4 or above.
WORK_RECORD_DB
: Contains CSV files with work records for different team members. Each file should follow the format described below.index.html
: The HTML file used for the front end.work_dashboard.php
: The PHP script that reads the CSV files, processes the data, and provides it to the front end ( dashboard ).
-
CSV Data Handling: The
work_dashboard.php
script reads CSV files from theWORK_RECORD_DB
folder. Each CSV file contains work records with the following columns:- Title: The title of the work.
- Description: A detailed description of the work.
- Label: The category or label of the work.
- Duration: Duration of work in hours.
- Timestamp: The date and time of the work submission.
-
Data Processing:
- Metrics such as total tokens, weekly average, and monthly average are calculated based on the work records.
- Weekly and monthly averages are computed only if the relevant time periods (7 days for weekly average and 30 days for monthly average) have passed to ensure accurate results.
- Detailed view of the timeline, displays recent updates & work logs
-
Display Data: The processed data is sent to the front-end, where it is displayed in the
dashboard
. TheshowDetails
JavaScript function dynamically updates the dashboard with the selected team member's work details.
-
CSV-Based Data: Data is stored in CSV files for simplicity and ease of integration. Each CSV file represents an individual team member's work log.
-
Metrics Calculation: Weekly and monthly averages are computed only if the respective time periods have passed. This avoids incorrect data due to incomplete periods.
-
Authentication: Each team member has an associated authentication key used to log/submit their work records. This ensures that only authorized users can enter data the data. Auth key e.g 'employee_name_rsz8739tx2'
-
To produce a new auth key go to the
WORK_RECORD_DB
folder and create a.CSV
file with the auth key as the name of the file. -
Each CSV file is linked to a unique authentication key. Users must provide the correct key to log their data. No auth key is required when accessing the dashboard.
Example of Dashboard use case
Feel free to report issues and contribute to this repository
Copyright (c) 2024 Abhijeet Kumar All rights reserved.
Licensed under the MIT License.