# clone the code.
$ git clone https://github.com/lemoncloud-io/eureka-sockets-api.git

# STEP.1 install the dependecies.
$ npm ci

# STEP.2 run the server locally.
$ npm run express

# STEP.3 make request and develop locally.
$ http :8832/hello

# STEP.4 deploy into your AWS cloud (`AWS-Key` is required).
$ npm run deploy

# (example) try to connect to a WebSocket
$ wscat -c wss://a5jxmksfa2.execute-api.ap-northeast-2.amazonaws.com/dev

# STEP.5 check the deploy info
$ npm run info

# STEP.6 remove(or uninstall)
$ npm run remove

src/
├── cores/                  # Common architecture
│   ├── abstract-controllers.ts  # CRUD controller base
│   ├── abstract-services.ts     # Service layer base
│   └── types.ts                 # Common types
├── libs/                  # Common architecture
│   └── wss/               # WebSocket support library (core module)
│       ├── tools.ts       # WebSocket support tools
│       ├── wss-agent.ts   # Websocket business logic
│       └── wss-types.ts   # Websocket types definitions
├── modules/                # Business modules
│   ├── sockets/             # Socket service (core module)
│   │   ├── api-sockets.ts   # Socket API controller
│   │   ├── api-channels.ts   # Socket Chnnel API controller
│   │   ├── model.ts       # Socket data model
│   │   ├── service.ts     # Socket business logic
│   │   ├── proxy.ts       # Socket data access
│   │   ├── transformer.ts # Data transformation
│   │   ├── types.ts       # Socket type definitions
│   │   └── views.ts       # Socket view models
│   ├── callback/          # External callback handling
│   │   ├── api-callback.ts
│   │   ├── model.ts
│   │   ├── service.ts
│   │   └── ...
│   ├── mock/              # Test mock data
│   │   ├── api-mocks.ts
│   │   ├── api-tests.ts
│   │   └── ...
│   └── search/            # Search functionality
│       ├── api-search.ts
│       ├── model.ts
│       └── service.ts
├── service/               # Core services
│   ├── backend-service.ts # Main service
│   ├── backend-proxy.ts   # Data access layer
│   └── backend-model.ts   # Data models
└── api/                   # API endpoints
├── hello-api.ts       # Health check
└── crons-api.ts       # Scheduled tasks

# 0. Create Channel (Optional)
$ echo '{"service": "orders-api", "modelType": "order", "desc": "Order events channel"}' | \
http POST :8832/channels/0

# 1. WebSocket Connection
$ wscat -c wss://<your-wss-endpoint>
$ wscat -c wss://<your-wss-endpoint>?channels=<channel-id> # w/ subscribe channel

# 2. Ping/Pong Action
> {"action": "ping", "data": "hello"}
< {"action": "pong", "data": "hello"}

# 3. Broadcast (HTTP API)
# Broadcast message to specific channel
$ echo '{"data": {"message": "hello"}}' | http POST :8832/sockets/1000001/broadcast

# Message received by subscribers
< {"channel": "1000001", "event": "message", "data": {"message": "hello"}}

# 4. Disconnect
# WebSocket connection termination (server automatically executes $disconnect handler)
> (Ctrl+C or close browser)