nanostream Webcaster API

Requirements

• NodeJS v18.x LTS

• Docker (optionally)

Setup

npm i
Copy

Development Server

run watch compiler + static server in background (port 9000)

npm run dev
Copy

Build

Debug

npm run build:dev
Copy

Prod

npm run build:prod
Copy

Docker

Usage documented by CI config (yml).

CI

• Main branch builds and deploys to https://webrtc.pages.nanocosmos.de/webcaster-api via gitlab pages.

• Feature branches, MRs will build Review Apps on k8s.

See Gitlab -> Deployments > Environments for deploy location.

Generate Docs

npm run docs
Copy

We use https://typedoc.org/

API Reference

Go to /docs/index.html on CI deploy location (or local build with the above run).

Contribute / Guidelines

Rules:

1. PRs are welcome
2. Reviews are mandatory
3. Work intended must be described priorly (e.g with a ticket or issue here)