MacD - Ledger Service

Ledger is a self-contained and scalable web service built for the MacD project, which is a Forex trading platform clone utilizing service-oriented architecture techniques.

Table of Contents

1. Features
2. Development
   1. Install Dependencies
   2. Usage
3. Requirements
4. Roadmap
5. Contributing
6. Architecture
   1. MacD System Diagram
   2. Ledger Dataflow Diagram
7. License

Features

• Polls real time price and volume updates, storing the data in a Postgres database.
• Computes the OHLC candlesticks data every 5 seconds and publishes to message bus (AWS SQS) in near real time.
• Polls and serves incoming requests for historical candlesticks data at various time intervals (1min, 5min, 1hour, 1day etc) in a given time period.

Development

Install Dependencies

$ npm install

Usage

Run tests:

$ npm test

Start Express Server:

$ npm start

Start Price Poll Worker:

$ npm run price-poll

Start Histical Request Poll Worker:

$ npm run hist-poll

Start 5 Sec Interval OHLC Worker:

$ npm run s5bars-worker

Start Materialized Views Auto Refresh Worker:

$ npm run mviews-worker

Requirements

• Node 6.9.x
• Redis 3.2.x
• Postgresql 9.6.x
• Elasticsearch
• Kibana
• AWS SQS
• AWS S3

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.

Architecture

MacD System Diagram

Ledger Dataflow Diagram

License

MIT © Kenny Cao