Skip to content

msgops-api

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

msgops-api

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
.gitlab/merge_request_templates
.gitlab/merge_request_templates
 
 
.husky
.husky
 
 
src
src
 
 
test/fixtures
test/fixtures
 
 
tests
tests
 
 
.dockerignore
.dockerignore
 
 
.env.example
.env.example
 
 
.gitignore
.gitignore
 
 
.lintstagedrc
.lintstagedrc
 
 
.npmrc
.npmrc
 
 
.prettierrc
.prettierrc
 
 
.sonarcloud.properties
.sonarcloud.properties
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 
commitlint.config.js
commitlint.config.js
 
 
docker-compose.yml
docker-compose.yml
 
 
dump.rdb
dump.rdb
 
 
environment.template
environment.template
 
 
eslint.config.mjs
eslint.config.mjs
 
 
jest.config.ts
jest.config.ts
 
 
nest-cli.json
nest-cli.json
 
 
package.json
package.json
 
 
schema.sql
schema.sql
 
 
tsconfig.build.json
tsconfig.build.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

msgops-api

Core REST API for Open BMS — authentication, accounts, contacts, campaigns, automations, segments and the super-admin surface. Backed by Postgres (operational data) via TypeORM and ClickHouse (analytics).

Run

pnpm --filter msgops-api dev          # watch mode, port 5001
pnpm --filter msgops-api build
pnpm --filter msgops-api test

Requires the infra stack from the root docker-compose.yml (Postgres, Redis, RabbitMQ, MinIO). See ../../docs/getting-started.md.

Env vars: copy .env.example to .env.

OpenAPI/Swagger docs are exposed at /api-docs when NODE_ENV !== production.