Skip to content

Commit f0c2b23

Browse files
Amin-MoniryAmin-Moniry
authored
Revise README for clarity and detail
Updated README to enhance project description, features, and installation instructions.
1 parent 1fbdad8 commit f0c2b23

1 file changed

Lines changed: 157 additions & 108 deletions

File tree

‎README.md‎

Lines changed: 157 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,91 @@
1-
# Syzaar+ 💛✨
1+
<div align="center">
22

3-
**An Intelligent Workforce Performance & Productivity Analytics Platform**
3+
<img src="https://readme-typing-svg.herokuapp.com?font=Orbitron&weight=700&size=45&duration=2500&pause=600&color=FFD60A&center=true&vCenter=true&width=700&lines=Syzaar%2B" alt="Syzaar+" />
44

5-
Transform your industrial operations with cutting-edge computer vision and data analytics. Built with Django and advanced machine learning to deliver actionable insights from your factory floor.
5+
<img src="https://readme-typing-svg.herokuapp.com?font=Fira+Code&weight=600&size=20&duration=3000&pause=1000&color=888888&center=true&vCenter=true&width=750&lines=Workforce+Performance+%26+Productivity+Analytics;Computer+Vision+%7C+Django+%7C+AI-Powered;Smart+Monitoring+for+Industrial+Environments" alt="Subtitle" />
6+
7+
<br>
68

79
![Python Version](https://img.shields.io/badge/Python-3.12-3776AB.svg?style=for-the-badge&logo=Python)
810
![Django Version](https://img.shields.io/badge/Django-5.0-092E20.svg?style=for-the-badge&logo=Django)
911
![OpenCV](https://img.shields.io/badge/OpenCV-4.8-5C3EE8.svg?style=for-the-badge&logo=OpenCV)
10-
![License](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)
12+
![License](https://img.shields.io/badge/License-MIT-FFD60A.svg?style=for-the-badge)
13+
![Status](https://img.shields.io/badge/UI-Completed-4CC9F0?style=for-the-badge)
14+
![AI](https://img.shields.io/badge/AI_Engine-In_Development-FF006E?style=for-the-badge)
15+
16+
<img src="https://user-images.githubusercontent.com/73097560/115834477-dbab4500-a447-11eb-908a-139a6edaec5c.gif">
17+
18+
</div>
1119

12-
## 🎯 Project Overview
20+
## Overview
1321

14-
Syzaar+ transforms raw visual data from industrial environments into actionable business intelligence. Our platform combines computer vision, machine learning, and intuitive web interfaces to help manufacturing facilities optimize workforce productivity, reduce operational costs, and maintain quality standards.
22+
**Syzaar+** is a next-generation workforce performance and productivity analytics platform designed for industrial and manufacturing environments. The platform converts raw visual data captured from IP camera infrastructure into structured, actionable business intelligence — enabling facility managers to optimize workforce activity, reduce operational inefficiencies, and uphold quality standards.
1523

16-
### Key Benefits:
17-
- **Real-time Monitoring**: Track workforce activity across multiple zones simultaneously
18-
- **Data-Driven Decisions**: Convert visual observations into quantifiable metrics
19-
- **Seamless Integration**: Works with existing IP camera infrastructure
20-
- **Scalable Architecture**: Built on Django for enterprise-level deployment
24+
The user interface and experience layer are fully developed and production-ready. The AI-powered detection engine — built on computer vision and deep learning technologies — is currently under active development and will be progressively integrated into the platform.
2125

22-
## 🌟 Core Features & Capabilities
26+
---
27+
28+
## Core Features
2329

2430
| Feature | Description | Status |
2531
|---------|-------------|--------|
26-
| 📍 **Precision Zone Management** | Define, edit, and manage specific work zones with an intuitive drag-and-drop interface. Isolate analysis to areas that matter most. | ✅ Done |
27-
| 🧠 **AI-Powered Activity Recognition** | Leverage advanced algorithms to automatically detect active vs. idle states, flagging anomalies and prolonged inactivity in real-time. | ⏳ Planned |
28-
| 📹 **Seamless Multi-Camera Integration** | Natively support and auto-discover up to 10 simultaneous IP camera streams, providing a comprehensive view of your operations. | ✅ Done |
29-
| 🤖 **Dedicated AI Models per Zone** | Assign specialized, fine-tuned AI models to each zone, ensuring maximum accuracy for diverse and specific tasks. | ⏳ Planned |
30-
| 📊 **Granular Data & Reporting** | Capture frame-by-frame performance data and generate comprehensive reports in standard formats like Excel for deep analysis. | ✅ Done |
31-
| 🖥️ **Intuitive & Dynamic UI** | A modern, responsive user interface with live visual labeling, providing at-a-glance insights without technical complexity. | ✅ Done |
32+
| 📍 **Zone Management** | Define, configure, and manage specific work zones via an intuitive drag-and-drop interface. Isolate analysis to areas of operational significance. | ✅ Complete |
33+
| 🧠 **AI Activity Recognition** | Automatically detect active versus idle workforce states, flagging anomalies and prolonged inactivity in real time using advanced algorithms. | ⏳ In Development |
34+
| 📹 **Multi-Camera Integration** | Native support for up to 10 simultaneous IP camera streams with automatic device discovery and unified monitoring. | ✅ Complete |
35+
| 🤖 **Per-Zone AI Models** | Assign dedicated, fine-tuned AI models to individual zones for maximum detection accuracy across diverse operational tasks. | ⏳ In Development |
36+
| 📊 **Data & Reporting** | Capture frame-by-frame performance data and export comprehensive reports in standard formats including Excel for further analysis. | ✅ Complete |
37+
| 🖥️ **Modern UI/UX** | A fully responsive, dynamic interface with live visual labeling and at-a-glance operational insights. | ✅ Complete |
38+
39+
---
40+
41+
## Technology Stack
42+
43+
| Layer | Technologies |
44+
|-------|-------------|
45+
| **Backend** | Python 3.12, Django 5.0 |
46+
| **Frontend** | HTML5, CSS3, JavaScript |
47+
| **Database** | SQLite 3 (Development), PostgreSQL (Production) |
48+
| **Computer Vision** | OpenCV 4.8 |
49+
| **AI / ML** | TensorFlow / PyTorch *(Planned)* |
50+
51+
---
52+
53+
## Screenshots
54+
55+
<div align="center">
56+
57+
### Zone Configuration Interface
58+
![Zone Configuration](Project_Picture/Image%20(2).png)
59+
60+
### Dashboard Overview
61+
![Dashboard UI](Project_Picture/Image%20(7).png)
3262

33-
## 🛠️ Technology Stack
63+
</div>
3464

35-
| Category | Technologies |
36-
|----------|-------------|
37-
| **Backend** | 🐍 Python, Django |
38-
| **Frontend** | 📄 HTML5, 🎨 CSS3, 💡 JavaScript |
39-
| **Database** | 🗄️ SQLite 3 (Default), 🐘 PostgreSQL (Production) |
40-
| **AI/ML** | 👁️ OpenCV, 🧠 TensorFlow/PyTorch (Planned) |
65+
---
4166

42-
## 🏗️ Project Structure
67+
## Project Structure
4368

4469
```
4570
Syzaar+/
4671
│
47-
├── Config/ # Main project configuration
72+
├── Config/ # Project configuration
4873
│ ├── settings.py
4974
│ └── urls.py
5075
│
51-
├── Detection_App/ # Core application
76+
├── Detection_App/ # Core application module
5277
│ ├── admin.py
5378
│ ├── forms.py
5479
│ ├── models.py
5580
│ ├── urls.py
5681
│ └── views.py
5782
│
58-
├── static/ # Static assets
59-
│ ├── css/ # Stylesheets
60-
│ ├── js/ # JavaScript files
61-
│ └── images/ # Image assets
83+
├── static/ # Static assets
84+
│ ├── css/
85+
│ ├── js/
86+
│ └── images/
6287
│
63-
├── templates/ # HTML templates
88+
├── templates/ # HTML templates
6489
│ ├── base.html
6590
│ ├── landing.html
6691
│ ├── login.html
@@ -73,68 +98,63 @@ Syzaar+/
7398
└── manage.py
7499
```
75100

76-
## Getting Started
101+
---
102+
103+
## Installation
77104

78105
### Prerequisites
79106

80107
- Python 3.12 or higher
81108
- Git
82109

83-
### Installation
84-
85-
1. **Clone the Repository**
86-
```bash
87-
git clone https://github.com/Amin-moniry-pr/syzaar-plus.git
88-
cd syzaar-plus
89-
```
90-
91-
2. **Create and Activate Virtual Environment**
92-
93-
**Windows:**
94-
```bash
95-
python -m venv venv
96-
.\venv\Scripts\activate
97-
```
98-
99-
**macOS/Linux:**
100-
```bash
101-
python3 -m venv venv
102-
source venv/bin/activate
103-
```
104-
105-
3. **Install Dependencies**
106-
```bash
107-
pip install -r requirements.txt
108-
```
109-
110-
4. **Apply Database Migrations**
111-
```bash
112-
python manage.py makemigrations
113-
python manage.py migrate
114-
```
115-
116-
5. **Create Superuser**
117-
```bash
118-
python manage.py createsuperuser
119-
```
120-
121-
6. **Run Development Server**
122-
```bash
123-
python manage.py runserver
124-
```
110+
### Setup
125111

126-
The application will be available at `http://127.0.0.1:8000/`
112+
**1. Clone the repository**
113+
```bash
114+
git clone https://github.com/Amin-Moniry/syzaar-plus.git
115+
cd syzaar-plus
116+
```
117+
118+
**2. Create and activate a virtual environment**
119+
120+
Windows:
121+
```bash
122+
python -m venv venv
123+
.\venv\Scripts\activate
124+
```
125+
126+
macOS / Linux:
127+
```bash
128+
python3 -m venv venv
129+
source venv/bin/activate
130+
```
127131

128-
## 📋 Usage Guide
132+
**3. Install dependencies**
133+
```bash
134+
pip install -r requirements.txt
135+
```
136+
137+
**4. Apply database migrations**
138+
```bash
139+
python manage.py makemigrations
140+
python manage.py migrate
141+
```
129142

130-
1. **Access the Application**: Navigate to `http://127.0.0.1:8000/`
131-
2. **Login**: Use your superuser credentials
132-
3. **Admin Panel**: Access at `http://127.0.0.1:8000/admin/` for camera and zone management
133-
4. **Dashboard**: Explore different sections to manage operational data
143+
**5. Create a superuser account**
144+
```bash
145+
python manage.py createsuperuser
146+
```
134147

135-
## 📦 Dependencies
148+
**6. Start the development server**
149+
```bash
150+
python manage.py runserver
151+
```
136152

137-
Create a `requirements.txt` file with:
153+
The application will be available at `http://127.0.0.1:8000/`
154+
155+
---
156+
157+
## Dependencies
138158

139159
```
140160
Django>=5.0.0
@@ -143,38 +163,67 @@ Pillow>=10.0.0
143163
numpy>=1.24.0
144164
```
145165

146-
## 🛣️ Roadmap
166+
---
147167

148-
- [ ] Implement AI-powered activity recognition
149-
- [ ] Add dedicated AI models per zone
150-
- [ ] Enhance real-time analytics
151-
- [ ] Implement advanced reporting features
152-
- [ ] Add mobile app support
153-
- [ ] Integrate with external systems
168+
## Usage
154169

155-
## 🤝 Contributing
170+
1. Navigate to `http://127.0.0.1:8000/` and log in with your superuser credentials
171+
2. Access the admin panel at `http://127.0.0.1:8000/admin/` for camera and zone configuration
172+
3. Use the dashboard to monitor operational zones, review activity data, and generate reports
156173

157-
Contributions are welcome! Please feel free to submit a Pull Request.
174+
---
158175

159-
1. Fork the Project
160-
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
161-
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
162-
4. Push to the Branch (`git push origin feature/AmazingFeature`)
163-
5. Open a Pull Request
176+
## Roadmap
164177

165-
### 🖼️ Visual Showcase
178+
- [ ] AI-powered workforce activity recognition
179+
- [ ] Dedicated AI model assignment per zone
180+
- [ ] Enhanced real-time analytics engine
181+
- [ ] Advanced reporting and export features
182+
- [ ] Mobile application support
183+
- [ ] Third-party system integrations
166184

167-
#### Main Example:
168-
![Zone Configuration](Project_Picture/Image%20(2).png)
185+
---
169186

170-
#### Dashboard UI Preview:
171-
![Dashboard UI](Project_Picture/Image%20(7).png)
187+
## Contributing
188+
189+
Contributions are welcome. Please follow the standard workflow:
190+
191+
1. Fork the repository
192+
2. Create a feature branch — `git checkout -b feature/YourFeature`
193+
3. Commit your changes — `git commit -m 'Add YourFeature'`
194+
4. Push to the branch — `git push origin feature/YourFeature`
195+
5. Open a Pull Request with a clear description of the changes
196+
197+
---
198+
199+
## License
200+
201+
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for full details.
202+
203+
**© 2026 Amin Moniry (AminTivanix2) — All Rights Reserved**
204+
205+
---
206+
207+
## Contact & Support
208+
209+
<div align="center">
210+
211+
| Channel | Link |
212+
|---------|------|
213+
| 📧 Email | [amintivanix2@gmail.com](mailto:amintivanix2@gmail.com) |
214+
| 💻 GitHub | [Amin-Moniry](https://github.com/Amin-Moniry) |
215+
| 📱 Telegram | [@amintivanix2](https://t.me/amintivanix2) |
216+
| 🌐 Website | [allin1wrench.ir](https://allin1wrench.ir) |
217+
| 🐛 Issues | [GitHub Issues](https://github.com/Amin-Moniry/syzaar-plus/issues) |
218+
219+
</div>
220+
221+
---
172222

173-
## 📞 Support & Contact
223+
<div align="center">
174224

175-
- **GitHub**: ([https://github.com/Amin-moniry-pr/](https://github.com/Amin-moniry-pr7/))
176-
- **Issues**: Please report bugs and feature requests through GitHub Issues
177-
- **Email**: Contact the development team for enterprise support
225+
<img src="https://readme-typing-svg.herokuapp.com?font=Orbitron&weight=700&size=20&duration=3000&pause=1000&color=FFD60A&center=true&vCenter=true&width=700&lines=Built+with+%E2%9D%A4%EF%B8%8F+by+Amin+Moniry+(AminTivanix2);Transforming+Industrial+Operations+Through+AI;Smart+%7C+Scalable+%7C+Reliable" alt="Footer" />
178226

179-
If you find this project helpful, please consider giving it a ⭐ on GitHub!
227+
<img src="https://capsule-render.vercel.app/api?type=waving&color=FFD60A&height=120&section=footer&fontColor=240046" width="100%"/>
180228

229+
</div>

0 commit comments

Comments
 (0)