https://github.com/odynvolk/cryptifier

Application for retrieving prices of crypto currencies and notifying via Telegram.
https://github.com/odynvolk/cryptifier

bitcoin carbon-emissions crypto cryptocurrencies cryptocurrency telegram telegram-bot typescript

Last synced: 24 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/odynvolk/cryptifier
• Owner: odynvolk
• Created: 2021-11-13T18:58:54.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-24T09:42:26.000Z (9 months ago)
• Last Synced: 2024-04-24T19:04:46.583Z (7 months ago)
• Topics: bitcoin, carbon-emissions, crypto, cryptocurrencies, cryptocurrency, telegram, telegram-bot, typescript
• Language: TypeScript
• Homepage:
• Size: 570 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cryptifier

Fetches...

1. Price of crypto currencies from [https://www.coingecko.com/](https://colintalkscrypto.com/)

2. Number of reachable Bitcoin nodes from [https://bitnodes.io/](https://bitnodes.io/)

3. CBBI from [https://colintalkscrypto.com/](https://colintalkscrypto.com/)

3. Fear and Greed index from [https://alternative.me/](https://alternative.me/)

4. Carbon Emissions Futures from [https://sandbag.be/](https://sandbag.be/)

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...

```bash

$ 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)...

```bash

$ npm test

```