HealthBuddy

Web application where people share sports & wellness goals and achievements in a public feed, support each other with comments, and manage personal profiles.

---

1. Project Overview & Setup

Layer	Tech	Responsibility
Client	Flutter 3.19 (Web / Mobile)	UI, Riverpod state
Gateway	Nginx + Go	TLS, CORS, rate-limit
Auth Service	Go 1.22 + Gin	JWT, register / login
Feed Service	Go 1.22 + Gin	Posts & comments
Profile Service	Go 1.22 + Gin	User bio & avatars
Data	PostgreSQL 15	per-service DBs
Cache	Redis 7	sessions & hot posts

Quick Start

git clone https://github.com/your-org/health-buddy.git
cd health-buddy
cp .env.example .env          # fill secrets
docker compose up --build     # backend at http://localhost:8080
# Flutter
cd flutter_app && flutter run -d chrome   # or iOS / Android

2. Features presentation

Registration

Open profile and edit bio

Write new post

3. API Documentation

HealthBuddy API Reference

Base URLs

• Gateway: https://api.healthbuddy.app
• Local: http://localhost:8080

Global Headers

• Content-Type: application/json
• Authorization: Bearer <jwt>

---

AUTH SERVICE (/auth)

POST /auth/register

• Body: { username, email, password }
• Responses:
  • 201: { token }
  • 400: Invalid input
  • 500: Server error

POST /auth/login

• Body: { username, password }
• Responses:
  • 200: { token }
  • 401: Wrong credentials

GET /auth/users/{id}

• Headers: Authorization
• Responses:
  • 200: { id, username, email, created_at }
  • 404: Not found

DELETE /auth/users/{id}

• Responses:
  • 204: No content
  • 404: Not found

---

FEED SERVICE (/feed) • JWT required via X-User-ID

GET /feed/health

• Responses:
  • 200: { status: "ok" }
  • 503: { status: "down" }

POST /feed/publications

• Body: { title (≤300), content (≤10 000) }
• Responses:
  • 201: { post_id, user_id, title, content, created_at }

GET /feed/publications

• Responses:
  • 200: [ PublicationResponse… ] (newest first)

GET /feed/publications/{id}

• Responses:
  • 200: PublicationResponse
  • 404: Not found

PUT /feed/publications/{id}

• Body: { title, content }
• Responses:
  • 200: Updated object
  • 403: Forbidden
  • 404: Not found

DELETE /feed/publications/{id}

• Responses:
  • 204: No content
  • 403: Forbidden
  • 404: Not found

GET /feed/users/{userID}/publications

• Responses:
  • 200: [ PublicationResponse… ]

Comments

POST /feed/comments

• Body: { post_id, content (≤10 000) }
• Responses:
  • 201: { comment_id, user_id, content, created_at }

GET /feed/comments?post_id={postID}

• Responses:
  • 200: [ CommentResponse… ]
  • 400: Missing param

GET /feed/comments/{id}

• Responses:
  • 200: CommentResponse
  • 404: Not found

PUT /feed/comments/{id}

• Body: { content }
• Responses:
  • 200: Updated object
  • 403: Forbidden
  • 404: Not found

DELETE /feed/comments/{id}

• Responses:
  • 204: No content
  • 403: Forbidden
  • 404: Not found

---

PROFILE SERVICE (/profile) • JWT required

GET /profile/health

• Responses:
  • 200: { status: "ok" }

POST /profile

• Headers: X-User-ID, Content-Type
• Body: { name, bio?, avatar_url? }
• Responses:
  • 201: ProfileResponse (without posts)

GET /profile

• Responses:
  • 200: { user_id, name, bio, avatar, created_at, posts: [PublicationResponse…] }

PUT /profile

• Body: any subset of { name, bio, avatar_url }
• Responses:
  • 200: Updated ProfileResponse

DELETE /profile

• Responses:
  • 204: No content (cascades to Auth deletion)

---

Status Codes & Messages

• 200 OK: Request succeeded
• 201 Created: Resource created
• 204 No Content: Deletion succeeded
• 400 Bad Request: Validation / JSON error
• 401 Unauthorized: Invalid or missing JWT
• 403 Forbidden: Not owner
• 404 Not Found: Resource does not exist
• 500 Internal: Server or DB failure

---

Generated from Postman collections

4. Architecture Diagrams & Explanations

Folder Layout

health-buddy/                 # repo root
├── backend/
│   ├── services/
│   │   ├── auth_service/     # Auth micro-service
│   │   ├── feed_service/     # Feed micro-service
│   │   └── profile_service/  # Profile micro-service
│   └── gateway_service/      # Gateway
├── front-end/                # Flutter application
│   ├── pubspec.yaml
│   └── .gitignore
├── docker-compose.yml        # Orchestrates all services
└── README.md                 # Initial version

Contributing

Pull requests welcome. Open an issue first for large changes.

Implementation checklist

Technical requirements (20 points)

Backend development (8 points)

• [+] Go-based microservices architecture (minimum 3 services) (3 points)
• [+] RESTful API with Swagger documentation (1 point)
• [-] gRPC implementation for communication between microservices (1 point)
• [+] PostgreSQL database with proper schema design (1 point)
• [+] JWT-based authentication and authorization (1 point)
• [-] Comprehensive unit and integration tests (1 point)

Frontend development (8 points)

• [+] Flutter-based cross-platform application (mobile + web) (3 points)
• [+] Responsive UI design with custom widgets (1 point)
• [+] State management implementation (1 point)
• [-] Offline data persistence (1 point)
• [-] Unit and widget tests (1 point)
• [-] Support light and dark mode (1 point)

DevOps & deployment (4 points)

• [+] Docker compose for all services (1 point)
• [-] CI/CD pipeline implementation (1 point)
• [+] Environment configuration management using config files (1 point)
• [+] GitHub pages for the project (1 point)

Non-Technical Requirements (10 points)

Project management (4 points)

• [+] GitHub organization with well-maintained repository (1 point)
• [+] Regular commits and meaningful pull requests from all team members (1 point)
• [+] Project board (GitHub Projects) with task tracking (1 point)
• [+] Team member roles and responsibilities documentation (1 point)

Documentation (4 points)

• [+] Project overview and setup instructions (1 point)
• [+] Screenshots and GIFs of key features (1 point)
• [+] API documentation (1 point)
• [+] Architecture diagrams and explanations (1 point)

Code quality (2 points)

• [+-] Consistent code style and formatting during CI/CD pipeline (1 point)
• [+] Code review participation and resolution (1 point)

Bonus Features (up to 10 points)

• [-] Localization for Russian (RU) and English (ENG) languages (2 points)
• [+(3)] Good UI/UX design (up to 3 points)
• [-] Integration with external APIs (fitness trackers, health devices) (up to 5 points)
• [+] Comprehensive error handling and user feedback (up to 2 points)
• [+-] Advanced animations and transitions (up to 3 points)
• [+-] Widget implementation for native mobile elements (up to 2 points)

Total points implemented: 28,5/30 (excluding bonus points)

Note: For each implemented feature, provide a brief description or link to the relevant implementation below the checklist.