tgrander/blink

:postbox: The DoSomething.org message bus.

Blink

📮 The DoSomething.org Message Bus.

Development

Requirements

• Node.js v7.6+ for async/await support
• Docker with support of Compose file v3
• Yarn

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

Tests

You can run all tests and checks at once:

$ yarn all-tests

Or execute them individually:

Code style

$ yarn lint

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

BDD Tests

$ yarn test

BDD test uses the following utilities:

• AVA
• Chai, BDD/should flavor
• Supertest

Code coverage

$ yarn coverage

• NYC
• Codecov