NEW TO THE PROJECT? Start here: docs/getting-started/START_HERE.md
FIND YOUR TEAM: docs/getting-started/FIND_YOUR_TASKS.md
Quick Start (All Services): Runteam_dev_environments/platform-engineers/start.shor use docker compose directly
# 1. Clone the repository
git clone git@github.com:Team-Deepiri/deepiri-platform.git
cd deepiri-platform
# 2. Initialize submodules
./team_submodule_commands/platform-engineers/pull_submodules.sh
# 3. Build all services
./team_dev_environments/platform-engineers/build.sh
# 4. Start the full stack
./team_dev_environments/platform-engineers/start.sh
# OR use docker compose directly
docker compose -f docker-compose.dev.yml up -d
# 5. Access services
# - Frontend: http://localhost:5173
# - API Gateway: http://localhost:5100
# - Cyrex AI: http://localhost:8000
# - Synapse: http://localhost:8002
# - MLflow: http://localhost:5500- Docker & Docker Compose
- Git
- 8GB+ RAM recommended
Each team has its own development environment in team_dev_environments/:
| Team | Path | Description |
|---|---|---|
| Backend | team_dev_environments/backend-team/ |
Backend microservices |
| AI | team_dev_environments/ai-team/ |
AI/ML services (Cyrex, MLflow) |
| Frontend | team_dev_environments/frontend-team/ |
Web frontend |
| ML | team_dev_environments/ml-team/ |
Machine learning pipelines |
| Infrastructure | team_dev_environments/infrastructure-team/ |
Infrastructure services |
| Platform | team_dev_environments/platform-engineers/ |
All services |
| QA | team_dev_environments/qa-team/ |
QA testing environment |
# Backend Team
cd team_dev_environments/backend-team
./build.sh && ./start.sh
# AI Team
cd team_dev_environments/ai-team
./build.sh && ./start.sh
# Frontend Team
cd team_dev_environments/frontend-team
./build.sh && ./start.sh| Service | Port | Description |
|---|---|---|
| API Gateway | 5100 | Main entry point, routes requests to backend services |
| Auth Service | 5001 | User authentication, JWT tokens, login/register |
| Task Orchestrator | 5002 | Manages and tracks user tasks and workflows |
| Engagement Service | 5003 | Gamification: quests, streaks, leaderboards, rewards |
| Platform Analytics | 5004 | Tracks user events, metrics, and analytics data |
| Notification Service | 5005 | Push notifications, email notifications |
| External Bridge | 5006 | Integrates with external APIs and third-party services |
| Challenge Service | 5007 | User challenges, competitions, achievements |
| Realtime Gateway | 5008 | WebSocket server for real-time features |
| Messaging Service | 5009 | In-app messaging, chat functionality |
| Language Intelligence | 5010 | NLP, text processing, language capabilities |
| PrismPipe | 5011 | Capability-routed API pipeline - transforms requests through nodes |
| Service | Port | Description |
|---|---|---|
| Cyrex | 8000 | AI agent service - LLM orchestration, tool calling, agent workflows |
| Cyrex Interface | 5175 | Web UI for testing and interacting with Cyrex agents |
| Jupyter | 8888 | Jupyter notebooks for AI research and experimentation |
| MLflow | 5500 | ML experiment tracking, model registry, metrics |
| Ollama | 11434 | Local LLM inference runtime |
| Service | Port | Description |
|---|---|---|
| PostgreSQL | 5432 | Primary database - users, tasks, quests, metadata |
| Redis | 6379 | In-memory cache, session storage, pub/sub |
| InfluxDB | 8086 | Time-series database for analytics and metrics |
| Minio | 9000 | S3-compatible object storage for files |
| Milvus | 19530 | Vector database for embeddings and AI |
| pgAdmin | 5050 | PostgreSQL admin web interface |
| Adminer | 8080 | Database management web interface |
| Synapse | 8002 | Matrix server for decentralized chat |
| etcd | 2379 | Distributed key-value store for cluster state |
The platform uses git submodules for service repositories. Use the team-specific scripts:
# Pull submodules for a specific team
./team_submodule_commands/backend-team/pull_submodules.sh
# Update all submodules
./team_submodule_commands/all_submodules/pull_submodules.shdeepiri-core-api- Core APIdiri-cyrex- AI/ML servicedeepiri-api-gateway- API Gatewaydeepiri-auth-service- Authenticationdeepiri-external-bridge-service- External integrationsdeepiri-web-frontend- Web frontenddiri-helox- ML training pipelinesdeepiri-modelkit- Shared contractsdeepiri-language-intelligence-service- Language processingplatform-services/shared/deepiri-prismpipe- PrismPipe pipelineplatform-services/shared/deepiri-synapse- Matrix server
# Build all services
docker compose -f docker-compose.dev.yml build
# Start all services
docker compose -f docker-compose.dev.yml up -d
# Stop all services
docker compose -f docker-compose.dev.yml down
# View logs
docker compose -f docker-compose.dev.yml logs -f
# View specific service logs
docker compose -f docker-compose.dev.yml logs -f cyrex
# Restart service
docker compose -f docker-compose.dev.yml restart cyrex
# Check status
docker compose -f docker-compose.dev.yml psdeepiri-platform/
├── platform-services/
│ ├── backend/
│ │ ├── deepiri-api-gateway/
│ │ ├── deepiri-auth-service/
│ │ ├── deepiri-task-orchestrator/
│ │ ├── deepiri-engagement-service/
│ │ ├── deepiri-platform-analytics-service/
│ │ ├── deepiri-notification-service/
│ │ ├── deepiri-external-bridge-service/
│ │ ├── deepiri-challenge-service/
│ │ ├── deepiri-realtime-gateway/
│ │ ├── deepiri-messaging-service/
│ │ └── deepiri-language-intelligence-service/
│ └── shared/
│ ├── deepiri-prismpipe/ # Capability-routed API pipeline
│ ├── deepiri-synapse/ # Matrix server
│ └── deepiri-shared-utils/ # Shared utilities
├── diri-cyrex/ # AI/ML service
├── diri-helox/ # ML training pipelines
├── deepiri-web-frontend/ # React frontend
├── deepiri-modelkit/ # Shared contracts
├── team_dev_environments/ # Team-specific environments
├── team_submodule_commands/ # Submodule management scripts
├── docs/ # Documentation
└── docker-compose.dev.yml # Development configuration
- Clone the repository
- Initialize submodules for your team
- Create a feature branch
- Make your changes
- Build and test
- Submit a pull request
See LICENSE.md