1.0.3 • Published 7 months ago
@axeptio/privacy-score v1.0.3
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 like : https://scoring.taaste.io/google.com.json
Use this command line with your JSON stringified as argument to get the score of the website :
$ npm run score -- [YOUR_JSON_STRINGIFIED]
Contributing
- Create your feature branch from the
master
branch:git checkout -b name/my-new-feature master
orgit checkout -b name/my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin name/my-new-feature
- 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