📮 The DoSomething.org message broker.
Latest commit 7c6713a Nov 2, 2018

README.md

Blink wercker status codecov dependencies Status devDependencies Status

📮 The DoSomething.org Message Bus.

Development

Requirements

Installation

Install dependencies yarn install

Usage

  • Launch RabbitMQ docker-compose up
  • yarn web
  • Open http://localhost:5050
    Username: blink, password: blink.

Available services

  • localhost:5672: RabbitMQ AMQP
  • localhost:15672: RabbitMQ management.
    Username: blink, password: blink.

API Endpoints

Core

Endpoint Description
GET / Greetings
GET /api List available API versions
GET /api/v1 List V1 endpoints

V1 Endpoints

Routes

Tests

You can run all tests and checks at once:

$ yarn test:full

Or execute them individually:

Code style

$ yarn lint

We follow Airbnb JavaScript Style Guide, with minor DoSomething adjustments.

BDD Tests

Unit tests
$ yarn test
Integration tests
$ yarn test:integration
Lint, Unit, Coverage, and Integration
$ yarn test:full

BDD test uses the following utilities:

When running integration/full tests locally. Run docker-compose down && docker-compose up -d between runs to prevent collision with messages stored in the RabbitMQ Docker image.

Code coverage

$ yarn unit:coverage && yarn coverage:report:html