Have ideas to improve npm?Join in the discussion! »

user-data-for-fraud-prevention

1.0.4 • Public • Published

user-data-for-fraud-prevention

user-data-for-fraud-prevention logo

CircleCI Coverage Status NPM Version Contributions welcome code style: prettier npm All Contributors

Description

This is an npm library to detect some browser or device details of the user such as Timezone, screen sizes, browser configuration etc. Such details are often required to be sent by software providers to the tax authority in their country to prevent fraud.

Eg: The Tax Authority in the UK (HMRC) requires software providers using some of their APIs to provide consistent headers known as Fraud Prevention headers. This node module collects such information for you in the format required.

Each top level folder in src/js has its own README with more specific information around the use case. E.g. HMRC README

How to use

Usage instructions can be found here

Demo

Steps for testing:

  • Run yarn link in user-data-for-fraud-prevention
  • Git clone the demo project here
  • In the demo project, run below commands:
    • Run yarn
    • Run yarn start
    • Run yarn demo
    • Run yarn link "user-data-for-fraud-prevention"

Now you can make changes in user-data-for-fraud-prevention locally and they will instantly reflect in the demo project.

You can check the browser console for errors.

Contributing

We do not allow contributors to claim issues. If you find something interesting you can contribute to the repo, feel free to raise a PR. We do not require you to let us know in advance.

  1. Fork the repo
  2. Install dependencies locally by running yarn or npm install
  3. Make your changes
  4. Make sure it builds using yarn build or npm run build
  5. Run the tests (you added tests, right?) with npm test or yarn tests
  6. Test your changes in your consuming code or using our demo project: Run yarn link or npm link
  7. Ensure the code coverage is the same or higher than before your changes
  8. Create a PR to the master branch

How contributors get added to the README

There are two ways to add yourself as a contributor to this repo:

  1. Call @all-contributors bot by adding this following comment in a PR: @all-contributors please add [username] for [contributions]. Please refer to the docs for more info.
  2. Use the all-contributors-cli by running npx all-contributors add [username] [contributions]. Please refer to the docs for more info.

All parameters are required. See the Emoji Key (Contribution Types Reference) for a list of valid contribution types.

License

License

Changelog

Please see our CHANGELOG

Contributors


Rachel Quan

🔧 📖

Reuben

📖 👀 ⚠️ 💬 💻

Susmitha Kodamarthi

📖 👀 ⚠️ 💬 💻

Mayank Khanna

💻

Jitin Maherchandani

💻

Install

npm i user-data-for-fraud-prevention

DownloadsWeekly Downloads

29

Version

1.0.4

License

ISC

Unpacked Size

20 kB

Total Files

8

Last publish

Collaborators

  • avatar
  • avatar