Skip to content

Commit 9eaca2c

Browse files
authored
docs: add readme.md
* add flutter-architecture.md * add guildlines/conventional-commit.md * add database-schema.md * add readme.md
1 parent f330636 commit 9eaca2c

2 files changed

Lines changed: 49 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
# TaskManagement
1+
# Task Management App - Life Organizer
2+
3+
## 1. Introduction
4+
This repository contains the source code for the **Task Management App (Life Organizer)**, developed as a project for the **SE346** course at the University of Information Technology - VNUHCM (UIT).
5+
6+
Going beyond a traditional to-do list, this application is designed to be a comprehensive personal assistant. It helps users easily organize various life contexts, such as tracking utility bills, managing grocery shopping lists, building daily habits, and handling household chores efficiently.
7+
8+
## 2. Authors
9+
This project is built and maintained by a dedicated team of 4 members:
10+
* [Trần Quang Hạ](https://github.com/tqha1011)
11+
* [Nguyễn Lê Hoàng Hảo](https://github.com/hoanghaoz)
12+
* [Nguyễn Anh Kiệt](https://github.com/anhkietbienhoa-crypto)
13+
* [Nguyễn Trí Kiệt](https://github.com/Ender-Via)
14+
15+
## 3. Tech Stack
16+
The application is built with a focus on performance, security, and clean code principles, strictly following the **Feature-Based MVVM** architecture:
17+
* **Frontend:** Flutter
18+
* **Backend & Database:** Supabase (PostgreSQL, Auth, Row Level Security)
19+
* **Code Quality & CI/CD:** GitHub Actions, SonarCloud
20+
21+
## 4. Documentation
22+
For a deeper dive into our system design and development workflows, please explore the attached documentation:
23+
* [Flutter App Architecture](documentation/architecture/flutter-architecture.md)
24+
* [Database Schema & ERD](documentation/architecture/database-schema.md)
25+
* [Git & Conventional Commits Guidelines](documentation/guidelines/conventional-commit.md)
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## 📌 Git Commit Convention
2+
3+
To maintain a clean, readable, and trackable commit history, all team members **MUST** adhere to the following commit guidelines.
4+
5+
### 1. Standard Syntax
6+
`<type>(<scope>): <short_description>`
7+
8+
### 2. Allowed Types
9+
10+
| Icon | Type | Description | Example |
11+
| :---: | :--- | :--- | :--- |
12+
|| **feat** | Adds a new feature to the application. | `feat(auth): add JWT login API` |
13+
| 🐛 | **fix** | Patches a bug or resolves an issue. | `fix(cart): resolve incorrect total price calculation` |
14+
| ♻️ | **refactor**| Restructures code without changing existing logic or adding features. | `refactor(product): clean up IProductService interface` |
15+
| 📝 | **docs** | Adds or updates documentation (README, diagrams, etc.). | `docs(ci): update SonarCloud workflow` |
16+
| 🔧 | **chore** | Maintenance tasks, configurations, or dependency updates. | `chore(deps): bump Newtonsoft.Json to 10.0.4` |
17+
| 🚀 | **perf** | Code changes that improve performance. | `perf(db): add index to Product table for faster queries` |
18+
19+
### 3. Golden Rules
20+
- The `type` and `scope` MUST strictly be in **lowercase**.
21+
- The description must be clear, concise, and straight to the point.
22+
- **NEVER** push code with meaningless commit messages such as: `update`, `fix bug`, `done part A`, `asdfgh`.
23+
24+
Reference: [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)

0 commit comments

Comments
 (0)