israelite6 / wonderq

WonderQ

WonderQ is a broker that allows producers to write to it, and consumers to read from it. It runs on a single server and has a single message queue.

Description

Built with Nest framework TypeScript.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

API Documentation

The documentation is in swaggar

http://localhost:3000/api

Code documentation

$ npx @compodoc/compodoc -p tsconfig.json -s

Open this on browser

http://localhost:8080

API Description

Post message to the queue

POST http://localhost:3000/messages
    payload {
        message: string
    }
    
    response {
        id: string
    }

Get messages in the queue

GET http://localhost:3000/messages
    response [{
        id: string,
        message: string,
        timestamp: string,
        isProcessing: boolean
    }]

Consume messages in the queue

GET http://localhost:3000/consumes?take=2
    response [{
        id: string,
        message: string,
        timestamp: string,
    }]

Acknowledge message in the queue

POST http://localhost:3000/acknowledges
    payload {
        id: string
    }
    
    response {
        id: string,
        acknowledged: true
    }

API Postman Collection

WonderQ.postman_collection.json file is located at the root directory