About the Project

This repository hosts a flexible rating algorithm designed for accurate rating and ranking based on specified criteria, used on some of our products

Getting Started

⚠️ Prerequisites

• Install NodeJS

⚙️ Run locally

• Get a JSON containing some results criteria of a website (cf. taste scoring api)

• Use this command line with your JSON stringyfied as argument to get the score of the website :

$ npm run score -- [YOUR_JSON_STRINGIFIED]

Contributing

1. Create your feature branch from the master branch: git checkout -b name/my-new-feature master or git checkout -b name/my-new-feature
2. Commit your changes: git commit -am 'Add some feature'
3. Push to the branch: git push origin name/my-new-feature
4. Submit a pull request and select as the base branch the master branch

Deployment

Publish a new release on Github with a semantic versioning tag.

Unit tests

You can run the unit tests with :

$ npm run test