Skip to content

Commit 7a76a95

Browse files
committed
docs: update README to enhance project overview and feature descriptions
- Added a preview section with images to showcase the CommitFlow interface. - Expanded the features section to include AI-powered insights and team coordination tools. - Updated the tech stack details for both frontend and backend, highlighting key technologies used. - Improved organization and clarity of content for better user understanding.
1 parent 1b2f336 commit 7a76a95

File tree

4 files changed

+92
-11
lines changed

4 files changed

+92
-11
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 92 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ With CommitFlow, you can **plan, track, and analyze your projects** β€” all in o
1414

1515
---
1616

17+
## ![CommitFlow Preview](./images/commitflow.jpg)
18+
19+
| Chat 1 | Chat 2 |
20+
| ---------------------------------- | ---------------------------------- |
21+
| ![](./images/commitflow-chat1.jpg) | ![](./images/commitflow-chat2.jpg) |
22+
23+
---
24+
1725
## πŸ“ Folder Structure
1826

1927
```
@@ -31,7 +39,15 @@ With CommitFlow, you can **plan, track, and analyze your projects** β€” all in o
3139

3240
## ✨ Features
3341

34-
### πŸ”§ Project Management
42+
### πŸ€– AI-Powered Insights
43+
44+
- πŸ’‘ **AI Recommendations** – Get automatic suggestions for prioritization and sprint planning.
45+
- 🧠 **Smart Summaries** – Let AI summarize repository activity and project status.
46+
- πŸ—£οΈ **Insight Chatbot** – Ask questions like β€œwhich tasks are in progress??” or β€œwho contributed the most to the commitflow repo?”
47+
48+
---
49+
50+
### 🧭 Project Management
3551

3652
A beautiful, AI-assisted workspace for managing your projects and tasks:
3753

@@ -45,14 +61,38 @@ A beautiful, AI-assisted workspace for managing your projects and tasks:
4561
- **Inline comments** with author, timestamp, and preview links
4662
- 🎨 **Smart Selectors** –
4763
- Assignee and Priority fields powered by **React Select**, dynamically colored per user or priority level
48-
- 🧍 **Team Management** –
49-
Add or remove team members using modern UI components, with color-coded avatars automatically generated.
64+
- πŸ—ƒοΈ **Workspace Management** –
65+
Add workspace.
5066
- 🧱 **Project Management Sidebar** –
5167
- Create or delete projects easily
5268
- Integrated **SweetAlert2** confirmations for safe deletions
69+
- 🧍 **Team Management** –
70+
Add or remove team members using modern UI components, with color-coded avatars automatically generated.
5371
- **Toast notifications** (`react-toastify`) for success actions (e.g., project or member added)
5472
- πŸŒ™ **Dark/Light Mode Aware** –
5573
Smooth color transitions and well-tuned contrast for both themes.
74+
- Due date labels: **Due Today** & **Overdue**
75+
- Filter **Assigned to Me**
76+
77+
---
78+
79+
### πŸ’¬ Team Coordination
80+
81+
- **Follow up tasks via WhatsApp**
82+
- Generates dynamic `wa.me` link (manual click β€” no API yet)
83+
- Pre-filled message with task title & status
84+
- Real-time collaboration coming soon
85+
- **Follow up tasks via WhatsApp**
86+
- **Automatic email notifications** sent to team members when tasks are updated
87+
- **Invite team members via email** with secure join links
88+
89+
---
90+
91+
### πŸ”„ Offline‑First Sync
92+
93+
- Works seamlessly **without internet**
94+
- Local storage caching (offline‑first approach)
95+
- Auto‑synchronization when back online
5696

5797
---
5898

@@ -64,19 +104,60 @@ A beautiful, AI-assisted workspace for managing your projects and tasks:
64104

65105
---
66106

67-
### πŸ€– AI-Powered Insights
107+
### 🎨 Interactive UI
68108

69-
- πŸ’‘ **AI Recommendations** – Get automatic suggestions for prioritization and sprint planning.
70-
- 🧠 **Smart Summaries** – Let AI summarize repository activity and project status.
71-
- πŸ—£οΈ **Insight Chatbot** – Ask questions like β€œWho’s most active this week?” or β€œWhich repo grew fastest?”
109+
- Smooth animations
110+
- Responsive layout
111+
- Clean, minimalist UX with focus on productivity
72112

73113
---
74114

75-
### 🐳 Infrastructure & Security
115+
## πŸ› οΈ Tech Stack
116+
117+
### Frontend
118+
119+
- React + Vite
120+
- TypeScript
121+
- TailwindCSS
122+
- Zustand (State Management)
123+
- LocalStorage / IndexedDB (Offline Sync)
124+
- React Query (Data Fetching & Sync Management)
125+
- Socket.IO Client (Real-time updates)
126+
- React Quill (Rich Text Editor)
127+
- SweetAlert2 (Dialogs)
128+
- React Toastify (Notifications)
129+
- Framer Motion / GSAP (Animations & interactive UI)
130+
- XLSX (Export Excel)
131+
132+
### Backend
133+
134+
- Nest.js
135+
- TypeScript
136+
- Prisma ORM
137+
- PostgreSQL
138+
- Socket.IO Gateway (Real-time events)
139+
- Nodemailer (Email Delivery via SMTP)
140+
- Multer (File upload middleware)
141+
- Class Validator / Class Transformer
142+
- Swagger (API documentation)
143+
- Google TTS API
144+
- AWS SDK for S3 Storage
145+
- JWT Authentication (Access & Refresh Tokens)
146+
- OpenAI API Integration (AI features / content generation)
147+
148+
---
76149

77-
- 🧩 **PostgreSQL Storage** – Store structured task and analytics data.
78-
- πŸ” **Environment Management** – Secure credentials via `.env` file.
79-
- βš™οΈ **Docker Ready** – Run everything locally or in production with one command.
150+
## 🐳 Infrastructure & Security (Updated)
151+
152+
- πŸ—„οΈ **PostgreSQL Database** – Structured project and task data.
153+
- ☁️ **AWS S3 Storage** – Media & attachments.
154+
- βœ‰οΈ **SMTP Email (Nodemailer)** – Invitations & notifications.
155+
- πŸ” **Environment Variables (.env)** – Secure credential management.
156+
- πŸ“‘ **WebSocket Gateway** – Realtime updates via Socket.IO.
157+
- πŸ”‘ **JWT Authentication** – Secure login, workspace access, and API protection.
158+
- πŸ€– **OpenAI Integration** – AI-driven generation (text, automation, suggestions).
159+
- πŸ“ **LocalStorage + IndexedDB** – Offline-first data with auto-sync.
160+
- πŸ“˜ **Swagger UI** – API documentation.
80161

81162
---
82163

β€Žimages/commitflow-chat1.jpgβ€Ž

69.3 KB
Loading

β€Žimages/commitflow-chat2.jpgβ€Ž

59.9 KB
Loading

β€Žimages/commitflow.jpgβ€Ž

105 KB
Loading

0 commit comments

Comments
Β (0)