Skip to content

Commit 92c9bc0

Browse files
authored
Revise README with project details and setup instructions
Updated project description and added local running instructions.
1 parent 2a9ef7e commit 92c9bc0

1 file changed

Lines changed: 78 additions & 2 deletions

File tree

README.md

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# TaskSync (in progress...)
1+
# TaskSync
22

33
![image](https://github.com/user-attachments/assets/b76e2876-caf7-4a0c-be71-ce80fa988038)
44

5-
A collaborative task management platform designed to simplify project organization and enhance team productivity. It enables real-time collaboration and task management through intuitive task boards inspired by Jira, providing a responsive, modern user experience.
5+
A collaborative real-time task management platform inspired by Jira-style Kanban boards.
66

77
## Key Features
88

@@ -22,3 +22,79 @@ A collaborative task management platform designed to simplify project organizati
2222
- **Database:** PostgreSQL
2323
- **CI/CD:** Docker, Azure, GitHub Actions
2424
- **Testing:** Jest, xUnit, Playwright
25+
26+
## Running Locally
27+
28+
### 0️⃣ Prerequisites
29+
- Node.js ≥ 22.14
30+
- .NET SDK ≥ 8.0
31+
- Docker
32+
33+
### 1️⃣ Start Infrastructure (PostgreSQL, RabbitMQ, OpenTelemetry Collector, Prometheus, Grafana, Tempo)
34+
```bash
35+
docker compose --profile=localdev up
36+
```
37+
Grafana: `http://localhost:3400`
38+
PostgreSQL: `http://localhost:5432`
39+
RabbitMQ Management: `http://localhost:15672`
40+
41+
### 2️⃣ Start Frontend
42+
```bash
43+
cd frontend
44+
npm install
45+
npm run dev
46+
```
47+
Frontend: `http://localhost:3039`
48+
49+
50+
### 3️⃣ Start Core API
51+
```bash
52+
cd backend
53+
dotnet restore
54+
dotnet run
55+
```
56+
Swagger: `http://localhost:5070/swagger`
57+
58+
### 4️⃣ Start Gamification API
59+
```bash
60+
cd gamification-api
61+
npm install
62+
npm run start:dev
63+
```
64+
Gamification API: `http://localhost:3000`
65+
66+
## Running Tests
67+
68+
### Frontend (Jest)
69+
```bash
70+
cd frontend
71+
npm run test
72+
npm run test -- src/sections/kanbanboard/kanban-item.test.tsx
73+
```
74+
75+
### Core API (xUnit)
76+
```bash
77+
cd backendtest
78+
dotnet test
79+
dotnet test --filter FullyQualifiedName~TaskServiceTest
80+
```
81+
82+
### Gamification API (Jest)
83+
```bash
84+
cd gamification-api
85+
npm run test
86+
npm run test -- src/points/points.service.spec.ts
87+
```
88+
89+
## Development Workflow
90+
- Create feature branch
91+
- Develop locally
92+
- Run tests
93+
- Push branch
94+
- Open Pull Request
95+
- CI + Presubmit review
96+
- Merge to main
97+
- Automatic Docker build + VM deployment
98+
99+
## CI/CD Pipeline
100+
TaskSync uses **GitHub Actions** for automated CI/CD. Workflow triggers on `main` branch

0 commit comments

Comments
 (0)