A microservice-based IM system built with Go.

• 🚀 Private & Group Chat
• 📞 Audio/Video Calls
• 📁 File Transfer
• ✅ Message Read Receipts
• 🔄 Multi-device Sync
• 📱 Offline Push Notifications

• Language: Go 1.24.9+
• Database: PostgreSQL 18+
• Cache: Redis 7.0+
• Message Queue: NATS
• Object Storage: MinIO
• Audio/Video: LiveKit
• Monitoring: Prometheus + Grafana
• Tracing: Jaeger
• Build Tool: Mage

• Go 1.24.9+
• Docker 28.1.1+ & Docker Compose 2.35.1+
• protoc 3.12.4+ (for gRPC code generation, requires --experimental_allow_proto3_optional)
• Mage (build tool)

go install github.com/magefile/mage@latest

# 1. Clone the repository
git clone https://github.com/yzhgit/anychat-server
cd server

# 2. Install dependencies
mage deps

# 3. Install development tools (optional)
mage install

# 4. Start infrastructure services
mage docker:up

# 5. Run database migrations
mage db:up

# 6. Start services
mage dev:auth
mage dev:gateway

anychat_server/
├── api/                    # API definitions
│   └── proto/             # gRPC definitions
├── cmd/                    # Application entry points
├── internal/               # Private code
├── pkg/                    # Shared libraries
├── deployments/            # Deployment configurations
├── configs/                # Configuration files
├── migrations/             # Database migrations
├── docs/                   # Documentation
│   └── api/swagger/       # OpenAPI specifications (auto-generated)
├── tests/                  # Tests
└── magefile.go            # Mage build scripts

# List all available commands
mage -l

# Build all services
mage build:all

# Build specific service
mage build:auth
mage build:gateway

# Build Docker images
mage docker:build

# Run all tests
mage test:all

# Run unit tests
mage test:unit

# Generate coverage report
mage test:coverage

# Code linting
mage lint

# Code formatting
mage fmt

• mage build:all - Build all services
• mage build:auth - Build auth service
• mage build:user - Build user service
• mage build:gateway - Build gateway service
• mage build:message - Build message service

• mage dev:auth - Run auth service
• mage dev:gateway - Run gateway service
• mage dev:message - Run message service
• mage proto - Generate protobuf code

• mage docker:up - Start all containers
• mage docker:down - Stop all containers
• mage docker:build - Build Docker images
• mage docker:logs - View logs
• mage docker:ps - View container status

• mage db:up - Run database migrations
• mage db:down - Rollback database migrations
• mage db:create <name> - Create new migration file

• mage docs:generate - Generate API documentation
• mage docs:serve - Start documentation server (http://localhost:3000)
• mage docs:build - Build documentation site
• mage docs:validate - Validate API documentation

• mage deps - Install dependencies
• mage install - Install development tools
• mage clean - Clean build artifacts
• mage mock - Generate mock code

• Full Documentation Site: GitHub Pages (auto-deployed)
• Local Preview: Run mage docs:serve and visit http://localhost:3000

• Getting Started - Beginner guide
• API Documentation - Interactive HTTP API documentation
• System Design - Architecture design document
• Writing API Documentation - How to write API documentation

# Generate API documentation
mage docs:serve

# Preview documentation site locally
mage docs:build

• Trigger: Push to main branch or create Pull Request
• Deployment Target: GitHub Pages
• Documentation URL: https://yzhgit.github.io/anychat-server/

Documentation is automatically updated when:

1. Gateway service code changes
2. Documentation files change
3. CI configuration changes

Add Swagger annotations for Gateway HTTP endpoints:

// Login user login
// @Summary      User login
// @Description  User login with username and password
// @Tags         Authentication
// @Accept       json
// @Produce      json
// @Param        request  body      LoginRequest  true  "Login information"
// @Success      200      {object}  response.Response{data=AuthResponse}  "Login successful"
// @Failure      400      {object}  response.Response  "Invalid parameters"
// @Router       /auth/login [post]
func (h *AuthHandler) Login(c *gin.Context) {
    // ...
}

See Writing API Documentation Guide for details.

Pull Requests and Issues are welcome.

MIT License - See LICENSE file