JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q22695F
  • License MIT

Application for retrieving prices of crypto currencies and notifying via Telegram.

Package Exports

  • cryptifier
  • cryptifier/src/app.ts

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cryptifier) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Cryptifier

Fetches...

  1. Price of crypto currencies from https://www.coingecko.com/
  2. Number of reacable Bitcoin nodes from https://bitnodes.io/
  3. CBBI from https://colintalkscrypto.com/
  4. Fear and Greed index from https://alternative.me/
  5. Carbon Emissions Futures from https://www.investing.com/
  6. Grayscale Bitcoin Premium from https://bitbo.io/

Notifies users of price going up or down in increments via...

  1. Telegram via a TelegramBot

Setup

Prerequisites:

  • Node.js

An easy way to setup Node is to use nvm. Then run nvm use to get the proper version specified in the project.

Then install the dependencies...

$ npm ci

Configuration:

Create a .env file with values needed in your setup.

logLevel=info|debug
currencies=[{"ticker": "bitcoin","increment": 1000}]
telegramApiKey=secret-key-for-bot
telegramChatIds=some-id,some-other-id

Development

Useful commands:

$ npm run dev - This will build images, scripts and styles and also watch changes in the two latter.

Testing

Tests are written in a BDD/Cucumber type syntax using mocha-cakes-2. Try to write tests in a meaningful way as to describe what it is you're testing and what resources are available. Testing does not only test a piece of code that it actually works but is also used for documentation purposes. Focus on testing what is vital for the feature.

To run all tests (including linting)...

$ npm test