Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 2.01 KB

README.md

File metadata and controls

32 lines (26 loc) · 2.01 KB
Raw

npm codecov Build status GitHub

David Dependency Status David Dev Dependency Status David Peer Dependencies Status

rankings

A server-only micro-service that upon request, calculates the rankings by requesting them from the scoring service

Background

The calculations of the rankings should be performed between the scoring and the display. This module is meant to be a REST API for anyone to consume the rankings at realtime.

Techincal details

This module is a node module (see the Module Standard).

Development

  1. Fork this repository or create your own branch here
  2. Make some changes
  3. Create a Pull Request
  4. Wait for a CR from the code owner
  5. Make sure everything is well
  6. Merge

A few things to notice while developing:

  • Use yarn not npm
  • Follow javascript standard as described here
  • Keep the service lightweight
  • Follow the API of the other modules, and try not to break API here. If you do break API, make sure the other modules are changed accrodingly.
  • Be creative and have fun