@@ -36,51 +36,55 @@ With CommitFlow, you can **plan, track, and analyze your projects** — all in o
3636A beautiful, AI-assisted workspace for managing your projects and tasks:
3737
3838- 🗂 ** Kanban Board** – Organize tasks visually using drag-and-drop.
39- Each task card shows ** priority color accents** , ** assignee avatars** , and ** due dates** .
40- - 📋 ** List View** – See all tasks in a clean table layout; click any row to open task details.
41- - 📆 ** Timeline View** – A Gantt-style horizontal timeline to visualize progress and overlaps between tasks.
42- - 💬 ** Task Details Modal** –
43- - ** Rich text editor** (React Quill) for descriptions
44- - ** File attachments** (via AWS S3 integration)
45- - ** Inline comments** with author, timestamp, and preview links
46- - 🎨 ** Smart Selectors** –
47- - Assignee and Priority fields powered by ** React Select** , dynamically colored per user or priority level
39+ Each task card shows ** priority color accents** , ** assignee avatars** , and ** due dates** .
40+ - 📋 ** List View** – See all tasks in a clean table layout; click any row to open task details.
41+ - 📆 ** Timeline View** – A Gantt-style horizontal timeline to visualize progress and overlaps between tasks.
42+ - 💬 ** Task Details Modal** –
43+ - ** Rich text editor** (React Quill) for descriptions
44+ - ** File attachments** (via AWS S3 integration)
45+ - ** Inline comments** with author, timestamp, and preview links
46+ - 🎨 ** Smart Selectors** –
47+ - Assignee and Priority fields powered by ** React Select** , dynamically colored per user or priority level
4848- 🧍 ** Team Management** –
49- Add or remove team members using modern UI components, with color-coded avatars automatically generated.
50- - 🧱 ** Project Management Sidebar** –
51- - Create or delete projects easily
52- - Integrated ** SweetAlert2** confirmations for safe deletions
49+ Add or remove team members using modern UI components, with color-coded avatars automatically generated.
50+ - 🧱 ** Project Management Sidebar** –
51+ - Create or delete projects easily
52+ - Integrated ** SweetAlert2** confirmations for safe deletions
5353 - ** Toast notifications** (` react-toastify ` ) for success actions (e.g., project or member added)
5454- 🌙 ** Dark/Light Mode Aware** –
5555 Smooth color transitions and well-tuned contrast for both themes.
5656
5757---
5858
5959### 📊 Developer Insights
60+
6061- 📈 ** GitHub Analytics** – Fetch organization repositories, commits, and contributor stats.
6162- 🔍 ** Contribution Breakdown** – Understand who contributes what and when.
6263- 📆 ** Activity Timeline** – Visualize commit frequency and collaboration trends.
6364
6465---
6566
6667### 🤖 AI-Powered Insights
68+
6769- 💡 ** AI Recommendations** – Get automatic suggestions for prioritization and sprint planning.
6870- 🧠 ** Smart Summaries** – Let AI summarize repository activity and project status.
6971- 🗣️ ** Insight Chatbot** – Ask questions like “Who’s most active this week?” or “Which repo grew fastest?”
7072
7173---
7274
7375### 🐳 Infrastructure & Security
76+
7477- 🧩 ** PostgreSQL Storage** – Store structured task and analytics data.
7578- 🔐 ** Environment Management** – Secure credentials via ` .env ` file.
7679- ⚙️ ** Docker Ready** – Run everything locally or in production with one command.
7780
7881---
82+
7983## ⚙️ Requirements
8084
81- - [ Docker] ( https://www.docker.com/get-started ) and Docker Compose
82- - A ** GitHub Personal Access Token** (with ` repo ` scope)
83- - An ** OpenAI API Key** (for AI Insights & Automation)
85+ - [ Docker] ( https://www.docker.com/get-started ) and Docker Compose
86+ - A ** GitHub Personal Access Token** (with ` repo ` scope)
87+ - An ** OpenAI API Key** (for AI Insights & Automation)
8488- ** AWS S3 Credentials** (for document and image storage)
8589
8690---
@@ -146,14 +150,19 @@ S3_ENDPOINT_URL=
146150---
147151
148152### 2. Build and start all containers
153+
149154For production:
155+
150156``` bash
151157./scripts/build.sh
152158```
159+
153160For development (with hot reload and live updates):
161+
154162``` bash
155163./scripts/build.dev.sh
156164```
165+
157166---
158167
159168### 3. Verify running containers
@@ -162,27 +171,27 @@ For development (with hot reload and live updates):
162171docker ps
163172```
164173
165- | Service | URL |
166- | ----------- | ------------------------ |
167- | Frontend | http://localhost:3000 |
168- | Backend | http://localhost:8000 |
169- | pgAdmin | http://localhost:8080 |
174+ | Service | URL |
175+ | -------- | --------------------- |
176+ | Frontend | http://localhost:3000 |
177+ | Backend | http://localhost:8000 |
178+ | pgAdmin | http://localhost:8080 |
170179
171180---
172181
173182### 4. Access pgAdmin
174183
175- - Email: ` admin@example.com `
184+ - Email: ` admin@example.com `
176185- Password: ` admin123 `
177186
178187Then add a new PostgreSQL server:
179188
180- | Field | Value |
181- | ------------ | -------------- |
182- | Host | db |
183- | Database | commitflow |
184- | User | postgres |
185- | Password | password |
189+ | Field | Value |
190+ | -------- | ---------- |
191+ | Host | db |
192+ | Database | commitflow |
193+ | User | postgres |
194+ | Password | password |
186195
187196---
188197
@@ -201,11 +210,13 @@ docker exec -it commitflow-api npx prisma db push
201210## 🧠 Running the Application
202211
203212** Development (hot reload):**
213+
204214``` bash
205215NODE_ENV=" development"
206216```
207217
208218** Production:**
219+
209220``` bash
210221NODE_ENV=" production"
211222```
@@ -214,6 +225,14 @@ You can switch between development and production using different Docker Compose
214225
215226---
216227
228+ ## Swagger Openapi
229+
230+ ```
231+ http://localhost:8000/docs
232+ ```
233+
234+ ---
235+
217236## 🤝 Contributing
218237
219238CommitFlow is open source and welcomes contributions!
0 commit comments