Skip to content

Commit 77e0219

Browse files
committed
✨ Initial release of CommitFlow — AI-powered GitHub Insight & Project Management Tool
0 parents  commit 77e0219

File tree

112 files changed

+22508
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+22508
-0
lines changed

.env.sample

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# ENV
2+
NODE_ENV="development"
3+
4+
# LOGGER
5+
DISCORD_WEBHOOK_URL=
6+
LOG_LEVEL=info
7+
8+
# PostgreSQL
9+
POSTGRES_USER=postgres
10+
POSTGRES_PASSWORD=password
11+
POSTGRES_DB=commitflow
12+
DB_PORT=5432
13+
14+
# pgAdmin
15+
PGADMIN_EMAIL=admin@example.com
16+
PGADMIN_PASSWORD=admin123
17+
ADMIN_PORT=8080
18+
19+
# Prisma (change db to localhost if not using docker)
20+
DATABASE_URL=postgresql://postgres:password@db:5432/commitflow
21+
22+
# Backend
23+
BE_PORT=8000
24+
OPENAI_API_KEY=
25+
BASE_URL=http://localhost:8000
26+
API_KEY=""
27+
JWT_SECRET=""
28+
29+
# Github user or org
30+
GITHUB_OWNER=
31+
GITHUB_TOKEN=
32+
33+
# Frontend
34+
FE_PORT=3000
35+
VITE_API_URL="http://localhost:8000"
36+
37+
# S3 Storage
38+
S3_BUCKET_NAME=
39+
S3_REGION=
40+
S3_ACCESS_KEY=
41+
S3_SECRET_KEY=
42+
# S3 COMPATIBLE STORAGE
43+
S3_ENDPOINT_URL=

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.env

CODE_OF_CONDUCT.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# 🌍 CommitFlow Code of Conduct
2+
3+
We are committed to fostering an open, welcoming, and inclusive community for everyone.
4+
Please follow these guidelines to help maintain a positive environment.
5+
6+
---
7+
8+
## 💬 Our Pledge
9+
10+
We pledge to make participation in our community a harassment-free experience for everyone, regardless of age, gender, sexual orientation, disability, physical appearance, body size, race, ethnicity, religion, or technical background.
11+
12+
---
13+
14+
## 🤝 Our Standards
15+
16+
Examples of behavior that contributes to a positive environment include:
17+
- Using welcoming and inclusive language
18+
- Respecting different viewpoints and experiences
19+
- Providing constructive feedback
20+
- Showing empathy toward other community members
21+
22+
Examples of unacceptable behavior include:
23+
- Harassment or discriminatory language
24+
- Personal attacks or insults
25+
- Publishing others’ private information
26+
- Disruptive or unprofessional conduct
27+
28+
---
29+
30+
## 🛠 Enforcement
31+
32+
Project maintainers are responsible for clarifying and enforcing this Code of Conduct.
33+
If you experience or witness behavior that violates these guidelines, please report it by opening an issue or contacting a project maintainer.
34+
35+
---
36+
37+
## ⚖️ Scope
38+
39+
This Code of Conduct applies to all spaces related to the project, both online and offline, including code repositories, issue trackers, discussion forums, and social media.
40+
41+
---
42+
43+
## ❤️ Attribution
44+
45+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

CONTRIBUTING.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# 🤝 Contributing to CommitFlow
2+
3+
Thank you for your interest in contributing to **CommitFlow** — an open-source AI-powered GitHub Insight & Project Management tool.
4+
We welcome all contributions, from small documentation fixes to major feature implementations.
5+
6+
---
7+
8+
## 🧭 Getting Started
9+
10+
1. **Fork** this repository and clone it locally:
11+
```bash
12+
git clone https://github.com/asepindrak>/commitflow.git
13+
cd commitflow
14+
```
15+
16+
2. Create a new branch for your changes:
17+
```bash
18+
git checkout -b feat/your-feature-name
19+
```
20+
21+
3. Make your changes and ensure everything works:
22+
```bash
23+
npm run lint
24+
npm run test
25+
```
26+
27+
4. Commit your changes using Conventional Commits:
28+
```bash
29+
feat: add new AI insight generator
30+
fix: resolve API token validation issue
31+
chore: update Docker build script
32+
```
33+
34+
5. Push your branch and open a Pull Request (PR):
35+
```bash
36+
git push origin feat/your-feature-name
37+
```
38+
39+
---
40+
41+
## 🧱 Development Setup ✨
42+
43+
To run the project locally using Docker:
44+
45+
```bash
46+
./scripts/build.dev.sh
47+
```
48+
49+
Access the services:
50+
51+
- Frontend: http://localhost:3000
52+
53+
- Backend: http://localhost:8000
54+
55+
- pgAdmin: http://localhost:8080
56+
57+
If you’re running it for the first time, migrate the database:
58+
```bash
59+
docker exec -it commitflow-api npx prisma db push
60+
```
61+
62+
---
63+
64+
## 🧠 Commit Message Convention ✨
65+
We follow Conventional Commits:
66+
| Type | Description |
67+
| ----------- | ----------------------------------------------------- |
68+
| `feat:` | A new feature |
69+
| `fix:` | A bug fix |
70+
| `docs:` | Documentation only changes |
71+
| `style:` | Code style (formatting, etc.) |
72+
| `refactor:` | Code changes that neither fix a bug nor add a feature |
73+
| `perf:` | Performance improvements |
74+
| `test:` | Adding or fixing tests |
75+
| `chore:` | Maintenance or build tasks |
76+
77+
Example:
78+
```bash
79+
feat: integrate GitHub API for contribution tracking
80+
```
81+
82+
83+
## 🧪 Running Tests ✨
84+
85+
If tests are available, you can run them with:
86+
87+
```bash
88+
npm test
89+
```
90+
---
91+
92+
## 🧾 Submitting Issues ✨
93+
94+
When reporting a bug or suggesting a feature:
95+
96+
- Check if an issue already exists.
97+
- Include steps to reproduce, expected behavior, and screenshots (if applicable).
98+
- Use a clear and descriptive title.
99+
100+
101+
## ❤️ Code of Conduct ✨
102+
103+
By contributing, you agree to follow our Code of Conduct
104+
105+
106+
## 🌟 Thank You!
107+
108+
Your contributions make CommitFlow better for everyone.
109+
We appreciate your time, effort, and ideas 💫.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Asep Kurniawan
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

0 commit comments

Comments
 (0)