Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tangy-foxes-float.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"commitflow": minor
---

workspace feature
11 changes: 10 additions & 1 deletion .env.sample
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,13 @@ S3_REGION=
S3_ACCESS_KEY=
S3_SECRET_KEY=
# S3 COMPATIBLE STORAGE
S3_ENDPOINT_URL=
S3_ENDPOINT_URL=

# Mail Server
SMTP_HOST=host.docker.internal
SMTP_PORT=587
SMTP_USER=
SMTP_PASS=
SMTP_SECURE=false # true untuk SMTPS(465), false untuk STARTTLS (587)
FROM_NAME=CommitFlow
FROM_ADDRESS=
75 changes: 47 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,51 +36,55 @@ With CommitFlow, you can **plan, track, and analyze your projects** — all in o
A beautiful, AI-assisted workspace for managing your projects and tasks:

- 🗂 **Kanban Board** – Organize tasks visually using drag-and-drop.
Each task card shows **priority color accents**, **assignee avatars**, and **due dates**.
- 📋 **List View** – See all tasks in a clean table layout; click any row to open task details.
- 📆 **Timeline View** – A Gantt-style horizontal timeline to visualize progress and overlaps between tasks.
- 💬 **Task Details Modal** –
- **Rich text editor** (React Quill) for descriptions
- **File attachments** (via AWS S3 integration)
- **Inline comments** with author, timestamp, and preview links
- 🎨 **Smart Selectors** –
- Assignee and Priority fields powered by **React Select**, dynamically colored per user or priority level
Each task card shows **priority color accents**, **assignee avatars**, and **due dates**.
- 📋 **List View** – See all tasks in a clean table layout; click any row to open task details.
- 📆 **Timeline View** – A Gantt-style horizontal timeline to visualize progress and overlaps between tasks.
- 💬 **Task Details Modal** –
- **Rich text editor** (React Quill) for descriptions
- **File attachments** (via AWS S3 integration)
- **Inline comments** with author, timestamp, and preview links
- 🎨 **Smart Selectors** –
- Assignee and Priority fields powered by **React Select**, dynamically colored per user or priority level
- 🧍 **Team Management** –
Add or remove team members using modern UI components, with color-coded avatars automatically generated.
- 🧱 **Project Management Sidebar** –
- Create or delete projects easily
- Integrated **SweetAlert2** confirmations for safe deletions
Add or remove team members using modern UI components, with color-coded avatars automatically generated.
- 🧱 **Project Management Sidebar** –
- Create or delete projects easily
- Integrated **SweetAlert2** confirmations for safe deletions
- **Toast notifications** (`react-toastify`) for success actions (e.g., project or member added)
- 🌙 **Dark/Light Mode Aware** –
Smooth color transitions and well-tuned contrast for both themes.

---

### 📊 Developer Insights

- 📈 **GitHub Analytics** – Fetch organization repositories, commits, and contributor stats.
- 🔍 **Contribution Breakdown** – Understand who contributes what and when.
- 📆 **Activity Timeline** – Visualize commit frequency and collaboration trends.

---

### 🤖 AI-Powered Insights

- 💡 **AI Recommendations** – Get automatic suggestions for prioritization and sprint planning.
- 🧠 **Smart Summaries** – Let AI summarize repository activity and project status.
- 🗣️ **Insight Chatbot** – Ask questions like “Who’s most active this week?” or “Which repo grew fastest?”

---

### 🐳 Infrastructure & Security

- 🧩 **PostgreSQL Storage** – Store structured task and analytics data.
- 🔐 **Environment Management** – Secure credentials via `.env` file.
- ⚙️ **Docker Ready** – Run everything locally or in production with one command.

---

## ⚙️ Requirements

- [Docker](https://www.docker.com/get-started) and Docker Compose
- A **GitHub Personal Access Token** (with `repo` scope)
- An **OpenAI API Key** (for AI Insights & Automation)
- [Docker](https://www.docker.com/get-started) and Docker Compose
- A **GitHub Personal Access Token** (with `repo` scope)
- An **OpenAI API Key** (for AI Insights & Automation)
- **AWS S3 Credentials** (for document and image storage)

---
Expand Down Expand Up @@ -146,14 +150,19 @@ S3_ENDPOINT_URL=
---

### 2. Build and start all containers

For production:

```bash
./scripts/build.sh
```

For development (with hot reload and live updates):

```bash
./scripts/build.dev.sh
```

---

### 3. Verify running containers
Expand All @@ -162,27 +171,27 @@ For development (with hot reload and live updates):
docker ps
```

| Service | URL |
|-----------|------------------------|
| Frontend | http://localhost:3000 |
| Backend | http://localhost:8000 |
| pgAdmin | http://localhost:8080 |
| Service | URL |
| -------- | --------------------- |
| Frontend | http://localhost:3000 |
| Backend | http://localhost:8000 |
| pgAdmin | http://localhost:8080 |

---

### 4. Access pgAdmin

- Email: `admin@example.com`
- Email: `admin@example.com`
- Password: `admin123`

Then add a new PostgreSQL server:

| Field | Value |
|------------|--------------|
| Host | db |
| Database | commitflow |
| User | postgres |
| Password | password |
| Field | Value |
| -------- | ---------- |
| Host | db |
| Database | commitflow |
| User | postgres |
| Password | password |

---

Expand All @@ -201,11 +210,13 @@ docker exec -it commitflow-api npx prisma db push
## 🧠 Running the Application

**Development (hot reload):**

```bash
NODE_ENV="development"
```

**Production:**

```bash
NODE_ENV="production"
```
Expand All @@ -214,6 +225,14 @@ You can switch between development and production using different Docker Compose

---

## Swagger Openapi

```
http://localhost:8000/docs
```

---

## 🤝 Contributing

CommitFlow is open source and welcomes contributions!
Expand Down
Loading