Skip to content

kigh-ota/remote-mob-timer

Repository files navigation

Remote Mob Timer

CircleCI

To run

docker-compose up -d
npm install && npm run build
npm run start:mongodb

or

# Use in-memory DB for dev
npm install && npm run build
npm run start:inmemory

API

Endpoint Description Request Response
GET /v1/timer/{id}/status Get timer's status {timer: {name, time, nClient, isRunning}, eventHistory: IEvent[]}
POST /v1/timer/{id}/reset?sec={sec}?name={name} Reset timer
POST /v1/timer/{id}/toggle?name={name} Toggle timer start/stop {isRunning, time}
PUT /v1/timer/{id}/name Change timer name {name}
POST /v1/timer/{id}/good?name={name} Send a "good!" event
GET /v1/timers Get list of timers
PUT /v1/timer/{id} Add a timer

Environment variables

Name Description
PORT HTTP Port
PERSISTENCE_TYPE INMEMORY or MONGODB or FIRESTORE}
FIRESTORE_DATABASE_URL
FIRESTORE_SERVICE_ACCOUNT_JSON

Uses

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published