GoFr-SOC: Template Track – Chat Service

[talanayush]

Hello GoFr team,

I’ll be building a scalable WebSocket‑based chat service with real‑time messaging, persistent storage, user presence tracking, channel‑based rooms, and delivery acknowledgments. It will be packaged as a drop‑in GoFr module with a clean three‑layer architecture (Handler → Service → Store), fully tested, linted, and with CI/CD in place.

Github Repository : https://github.com/talanayush/gofr-chat

Week 1 Plan

Project setup, Health Check, and Basic WebSocket “Echo” Endpoints

Description

• Initialize GoFr project with Handler/Service/Store structure

• Add configuration management and .golangci.yml

• Implement /health endpoint (checks service + PostgreSQL connectivity)

• Scaffold WebSocket handler:

  • GET /ws/connect upgrade to WebSocket
  • Simple “echo” back any message under a default channel

• Wire up PostgreSQL & Redis clients in main.go (no persistence logic yet)

• Integrate golangci-lint and GitHub Actions CI for linting & tests

Deliverables

• GET /health returns {"status":"ok"} and verifies DB connection
• GET /ws/connect successfully upgrades and echoes messages
• PostgreSQL and Redis clients are initialized in app context
• 100% unit‑test coverage for health and echo behavior
• CI pipeline runs lint and tests cleanly
• README with setup instructions and API usage examples

---

I’d love your feedback on this PR 1 plan and also kindly provide me with any resource that you think might help me with this project.

[coolwednesday]

Hey @talanayush ! You can start with your implementation. In the first PR, set up three layer architecture structure and update readme with your architecture plan (endpoints and build a swagger around the same). After this create the PR and add me as the collaborator for review.

[coolwednesday]

@talanayush , Any updates ?

[talanayush]

✅ Completed my first PR!
I've sent you the collaborator invite — just waiting for you to accept it so I can assign you as the reviewer.

[coolwednesday]

@talanayush, Please address the review comments. talanayush/gofr-chat#1 (review)