Skip to content

Commit a315233

Browse files
author
Jeffrey-Xu
committed
docs: Add README for game-engine service
- Comprehensive documentation for the Monopoly game engine - API endpoints and WebSocket events documentation - Development and deployment instructions - This commit should trigger the GitHub Actions CI workflow
1 parent 767a214 commit a315233

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

monopoly/game-engine/README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Monopoly Game Engine
2+
3+
## Overview
4+
Core game engine microservice for the Monopoly Go multiplayer gaming platform.
5+
6+
## Features
7+
- **Real-time Multiplayer**: WebSocket-based gameplay
8+
- **RESTful API**: Game management and player actions
9+
- **Scalable Architecture**: Kubernetes-ready microservice
10+
- **Multi-platform**: Supports both AMD64 and ARM64 architectures
11+
12+
## API Endpoints
13+
14+
### Health Check
15+
```
16+
GET /health
17+
```
18+
19+
### Game Management
20+
```
21+
POST /games # Create new game
22+
GET /games/:id # Get game state
23+
POST /games/:id/join # Join game
24+
POST /games/:id/roll # Roll dice and move
25+
```
26+
27+
## WebSocket Events
28+
- `joinGame` - Join game room
29+
- `gameUpdate` - Real-time game state updates
30+
- `playerJoined` - New player notifications
31+
- `playerDisconnected` - Player disconnect events
32+
33+
## Development
34+
35+
### Local Development
36+
```bash
37+
npm install
38+
npm run dev
39+
```
40+
41+
### Docker Build
42+
```bash
43+
docker build -t monopoly-game-engine .
44+
docker run -p 3001:3001 monopoly-game-engine
45+
```
46+
47+
### Testing
48+
```bash
49+
npm test
50+
npm run lint
51+
```
52+
53+
## Environment Variables
54+
- `PORT` - Server port (default: 3001)
55+
- `NODE_ENV` - Environment (development/production)
56+
57+
## CI/CD
58+
This service is automatically built and deployed via GitHub Actions:
59+
- **CI**: Builds multi-arch Docker images on code changes
60+
- **CD**: Deployed to Kubernetes via ArgoCD
61+
62+
Built with ❤️ for the global gaming community!

0 commit comments

Comments
 (0)