https://github.com/m1thrandir225/meridian
A real-time messaging platform
https://github.com/m1thrandir225/meridian
chat ddd-architecture event-driven golang grpc kafka microservices redis
Last synced: 6 months ago
JSON representation
A real-time messaging platform
- Host: GitHub
- URL: https://github.com/m1thrandir225/meridian
- Owner: m1thrandir225
- License: mit
- Created: 2025-05-07T08:54:38.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-09-22T10:36:52.000Z (6 months ago)
- Last Synced: 2025-09-22T12:15:51.071Z (6 months ago)
- Topics: chat, ddd-architecture, event-driven, golang, grpc, kafka, microservices, redis
- Language: Go
- Homepage: https://meridian.sebastijanzindl.me
- Size: 2.55 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Meridian is a modern, real-time communication platform built with Domain Driven Design (DDD) microservices architecture. Experience a seamless chat with enterprise-grade security, real-time messaging, and powerful integration capabilities.
---
## 🌟 Features
🚀 Real-time Messaging
- WebSocket-powered instant messaging
- Channel-based communication
- Message threading and reactions
- Typing indicators and presence
🔐 Enterprise Security
- PASETO token authentication
- Role-based access control
- Secure API token management
- Encrypted data transmission
🤖 Bot & Webhook Integration
- REST API and gRPC interfaces
- Custom webhook endpoints
- Third-party platform bridges
📊 Analytics & Insights
- Real-time usage analytics
- User engagement metrics
- Channel activity tracking
- Custom dashboard views
## 🏗️ Architecture
Meridian follows **Domain Driven Design** principles with a clean microservices architecture:
```mermaid
graph TB
subgraph "Frontend Layer"
A[Vue.js Frontend]
B[Landing Page]
end
subgraph "API Gateway"
C[Traefik Proxy]
end
subgraph "Microservices"
D[Identity Service
:8080]
E[Messaging Service
:8081]
F[Integration Service
:8082]
G[Analytics Service
:8083]
end
subgraph "Data Layer"
H[(PostgreSQL
Databases)]
I[(Redis
Cache)]
end
subgraph "Event Streaming"
J[Apache Kafka
:9092]
K[Zookeeper
:2181]
end
A --> C
B --> C
C --> D
C --> E
C --> F
C --> G
D --> H
E --> H
F --> H
G --> H
D --> I
E --> I
F --> I
D --> J
E --> J
F --> J
G --> J
J --> K
```
### 🎯 Core Services
| Service | Port | Purpose | Technology |
| ----------------------------------------------- | ------- | -------------------------------- | ----------------------------------- |
| **[Identity](docs/services/identity.md)** | `:8080` | User authentication & management | Go + PostgreSQL + Redis |
| **[Messaging](docs/services/messaging.md)** | `:8081` | Real-time chat & channels | Go + PostgreSQL + Redis + WebSocket |
| **[Integration](docs/services/integration.md)** | `:8082` | Webhooks & bot integrations | Go + PostgreSQL + Redis |
| **[Analytics](docs/services/analytics.md)** | `:8083` | Usage analytics & insights | Go + PostgreSQL + Kafka |
## 🚀 Quick Start
### Prerequisites
- **Docker** & **Docker Compose** v2+
- **Go** 1.24+ (for development)
- **8GB+ RAM** recommended
### Quick Setup
```bash
# Clone the repository
git clone https://github.com/your-org/meridian.git
cd meridian
# Setup environment and start services
make setup
make docker-build
make docker-up
```
**Note**: Go is required for initial setup as you need to run the script to generate PASETO Asymmetric keys, if you just want to purely run it with docker, altough not recommended, here are placeholder Paseto Keys:
```bash
#PRIVATE KEY (64 bytes / 128 hex chars):
de62c9983573159bc401db26eaad66f57f58127dfa74b409fc47721cf1c37d41acd1c1d9208c09f6990d84d19bfbee24e9f26ed8613819aa9ecbcf082cf24919
#PUBLIC KEY (32 bytes / 64 hex chars):
acd1c1d9208c09f6990d84d19bfbee24e9f26ed8613819aa9ecbcf082cf24919
```
Replace the keys in your `deployments/.env` file.
### Verify Installation
```bash
# Check service health
curl http://localhost:8080/health # ✅ Identity Service
curl http://localhost:8081/health # ✅ Messaging Service
curl http://localhost:8082/health # ✅ Integration Service
curl http://localhost:8083/health # ✅ Analytics Service
```
### Access the Platform
- **Frontend Application**: http://chat.localhost
- **Landing Page**: http://localhost
- **API**: http://api.localhost
- **API Documentation**: [docs/api/](docs/api/)
## 📖 Documentation
The comprehensive documentation covers everything you need:
| 📚 **Category** | 🔗 **Links** | 📝 **Description** |
| :------------------: | :-------------------------------------------------------------------------------------------- | :---------------------------------- |
| **🏗️ Architecture** | [Overview](docs/architecture/overview.md) • [Domain Model](docs/architecture/domain-model.md) | System design and DDD patterns |
| **📡 API Reference** | [REST](docs/api/rest-api.md) | Complete API documentation |
| **🚢 Deployment** | [Docker](docs/deployment/docker.md) | Deployment guide and best practices |
## 🛠️ Development
### Development Commands
```bash
# Setup and deployment
make setup # Generate keys and env file
make docker-build # Build all service binaries
make docker-up # Start all services
make docker-down # Stop and remove containers
# Development workflow
make test # Run tests
make lint # Run linters
make fmt # Format code
make tidy # Tidy Go modules
# Database operations
make migrate-up service= # Apply migrations
make migrate-down service= # Rollback migrations
make migrate-status service= # Check migration status
# Service-specific operations
make build-one service= # Build specific service
make docker-logs service= # View service logs
```
### Project Structure
```
meridian/
├── cmd/ # Service entry points
│ ├── identity/ # Identity service main
│ ├── messaging/ # Messaging service main
│ ├── integration/ # Integration service main
│ └── analytics/ # Analytics service main
├── internal/ # Service implementations
│ ├── identity/ # Identity domain, app, infra
│ ├── messaging/ # Messaging domain, app, infra
│ ├── integration/ # Integration domain, app,
├── pkg/ # Shared libraries
│ ├── auth/ # Authentication utilities
│ ├── kafka/ # Event streaming
│ ├── logging/ # Structured logging
│ └── cache/ # Caching utilities
├── deployments/ # Docker and deployment configs
├── docs/ # Documentation
└── examples/ # Integration examples (TODO)
```
### Code Quality
- **Domain Driven Design** principles
- **Clean Architecture** with clear boundaries
- **Structured logging** throughout
## 📄 License
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
---
**Built with ❤️ by the Sebastijan Zindl**
⭐ **Star us on GitHub** if you find this project interesting!
[📖 Documentation](docs/) • [🐛 Report Bug](https://github.com/m1thrandir225/meridian/issues) • [💡 Request Feature](https://github.com/m1thrandir225/meridian/issues/new?template=feature_request.md)