https://github.com/wmfs/tymly-rankings-plugin

https://github.com/wmfs/tymly-rankings-plugin

plugin tymly

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/wmfs/tymly-rankings-plugin
• Owner: wmfs
• License: mit
• Created: 2018-06-12T14:50:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-27T21:33:48.000Z (4 months ago)
• Last Synced: 2024-10-14T08:13:34.508Z (3 months ago)
• Topics: plugin, tymly
• Language: JavaScript
• Size: 1.28 MB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tymly-rankings-plugin

[![Tymly Plugin](https://img.shields.io/badge/tymly-plugin-blue.svg)](https://tymly.io/)

[![npm (scoped)](https://img.shields.io/npm/v/@wmfs/tymly-rankings-plugin.svg)](https://www.npmjs.com/package/@wmfs/tymly-rankings-plugin)

[![CircleCI](https://circleci.com/gh/wmfs/tymly-rankings-plugin.svg?style=svg)](https://circleci.com/gh/wmfs/tymly-rankings-plugin)

[![codecov](https://codecov.io/gh/wmfs/tymly-rankings-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/tymly-rankings-plugin)

[![CodeFactor](https://www.codefactor.io/repository/github/wmfs/tymly-rankings-plugin/badge)](https://www.codefactor.io/repository/github/wmfs/tymly-rankings-plugin)

[![Dependabot badge](https://img.shields.io/badge/Dependabot-active-brightgreen.svg)](https://dependabot.com/)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly-rankings-plugin/blob/master/LICENSE)

> Plugin which handles ranking of data

On tymly startup, this plugin searches the loaded blueprints for .json files in ranking directory. These ranking files indicate what factors should contribute to the ranking score and where to find the value to score. The plugin looks at these factors, and finds the corresponding weights in the registry-keys. With these weights, the plugin generates an SQL View statement which forms a table with scores per factor and a total score for each 'source' row.

The plugin also supplies a state-resource so it can be called to refresh a ranking, which will look to the database for up-to-date registry-keys.

See the test blueprint in /test/fixtures for an example of how to do this.

## Install

```bash

$ npm install tymly-rankings-plugin --save

```

## Testing

Before running the tests, you'll need a test PostgreSQL database available and set a `PG_CONNECTION_STRING` environment variable to point to it, for example:

```PG_CONNECTION_STRING=postgres://postgres:postgres@localhost:5432/my_test_db```

Once the environment variables have been set, you can run the tests like this:

```bash

$ npm test

```

## License

[MIT](https://github.com/wmfs/tymly/blob/master/LICENSE)