api documentation
Example : 
# DROPBET API

**Swagger:** `./swagger/api.swagger.json`

## Local Setup

On the first run, bring up the infrastructure in Docker (database, Redis, and RabbitMQ):

```bash
npm run dockers:infra

Create or update your .env file based on .local.env. Verify that DATABASE_URL and REDIS_PASSWORD in .env are correct and that the URL matches the Docker containers.

After every git pull, run:

Example : 
npm i
npm run db:migrate:dev    # Initializes the database. If a v1 database exists, this command will prompt to reset it.
npm run db:seed          # Creates default data including the admin/admin user.

Running Services

API (port 4000)

Example : 
# Main service for public and admin APIs
# Swagger UI is available at http://localhost:4000/swagger
npm run start:dev

Authentication methods supported:

  • Login / password
  • Google
  • Steam

Real-time Service (port 4001)

Example : 
# Required for WebSocket functionality
# Connect via socket.io at http://localhost:4001/events
# Only the websocket transport is supported: `transports: ['websocket']`. Polling is not supported.
npm run start:rt

Implementation Notes

  • Socket methods and events are defined in events.ts located at /apps/api/src/gateway/events.ts.
  • Data models are not fully defined at this time.
Example :

results matching ""

    No results matching ""