104 lines
4.9 KiB
Markdown
104 lines
4.9 KiB
Markdown
# Qlockify Showcase
|
|
|
|
Public product showcase for **Qlockify**, a time tracking and workspace reporting platform.
|
|
|
|
This repository is intentionally documentation-only. The production backend, frontend, and deployment source code are private.
|
|
|
|
## Live Demo
|
|
|
|
- Website: [https://qlockify.ir](https://qlockify.ir)
|
|
- Demo: use the demo entry point on the landing page to create an isolated temporary workspace.
|
|
|
|
## What Qlockify Does
|
|
|
|
Qlockify helps teams track billable work, manage workspace/project access, and export operational reports for clients, projects, tags, and team members.
|
|
|
|
Core capabilities:
|
|
|
|
- Mobile-first authentication with password, OTP, and Google OAuth account linking
|
|
- Workspace, member, client, project, and tag management
|
|
- Project-level access control for workspace members
|
|
- Workspace and project-based hourly rates
|
|
- Live timer and manual time entry management
|
|
- Admin/owner reporting dashboards
|
|
- Excel and PDF report exports
|
|
- Isolated demo environments for public product trials
|
|
- Audit logs, notifications, and operational visibility
|
|
|
|
## Architecture Overview
|
|
|
|
|
|
|
|
The production app is served behind Nginx with a React frontend, Django REST backend, PostgreSQL, Redis, Celery workers, and scheduled background jobs.
|
|
|
|
More details: [docs/architecture.md](docs/architecture.md)
|
|
|
|
## Product Docs
|
|
|
|
- [Features](docs/features.md)
|
|
- [Demo Guide](docs/demo-guide.md)
|
|
- [Architecture](docs/architecture.md)
|
|
- [Security and Privacy](docs/security-and-privacy.md)
|
|
|
|
## Screenshots
|
|
|
|
The screenshots below were captured from an isolated local demo workspace with seeded test data.
|
|
|
|
| Area | Preview |
|
|
| --- | --- |
|
|
| Landing |  |
|
|
| About |  |
|
|
| Authentication |  |
|
|
| Timesheet |  |
|
|
| My rates panel |  |
|
|
| Reports table |  |
|
|
| Reports chart |  |
|
|
| Clients |  |
|
|
| Client create modal |  |
|
|
| Client edit modal |  |
|
|
| Projects |  |
|
|
| Project create modal |  |
|
|
| Project access and rates |  |
|
|
| Tags |  |
|
|
| Tag create modal |  |
|
|
| Workspaces |  |
|
|
| Workspace edit page |  |
|
|
| Profile |  |
|
|
| Profile edit state |  |
|
|
| Admin dashboard |  |
|
|
| Admin users list |  |
|
|
| Admin user detail with social account inline |  |
|
|
| Admin workspaces list |  |
|
|
| Admin workspace detail with member inline |  |
|
|
| Admin projects list |  |
|
|
| Admin time entries list |  |
|
|
| Admin social accounts list |  |
|
|
| Admin contact submissions list |  |
|
|
|
|
More screenshots are available in [`assets/screenshots`](assets/screenshots/).
|
|
|
|
## Regenerating Screenshots
|
|
|
|
Screenshots are generated locally from a running Qlockify frontend/backend pair:
|
|
|
|
```powershell
|
|
cd scripts
|
|
npm install
|
|
cd ..
|
|
node scripts/capture-screenshots.js
|
|
```
|
|
|
|
The reusable script and its environment variables are documented in [`scripts/README.md`](scripts/README.md).
|
|
|
|
## Tech Stack
|
|
|
|
- Backend: Django, Django REST Framework, Celery
|
|
- Frontend: React, TypeScript, Vite
|
|
- Data: PostgreSQL, Redis
|
|
- Runtime: Docker, Nginx
|
|
- Operations: Gitea Actions, encrypted object-storage backups
|
|
|
|
## Source Code
|
|
|
|
The source code and deployment configuration are private/proprietary. This repository exists only to demonstrate the software, user experience, and technical architecture at a high level.
|