PraneshASP/cryptocurrency-price-alert

This is a service built using NodeJS, ExpressJS, BullMQ, etc to set alerts for cryptocurrency prices. Users will recieve email notification if the current price goes above/below the threshold.

JavaScript

Building cryptocurrency price alert service from scratch

Explore the post »

Report Bug · Request Feature

What's inside this repo?

Endpoints to create alerts,to fetch all the active alerts, and to get the current market price.
Job schedulers to remove the expired alerts automatically.
Process alerts using BullMQ
Send email notifications

For a more detailed explanation of the code, you can refer to my article posted on the Medium associated with this project.

Built With

Node.js - JavaScript runtime built on Chrome's V8 JavaScript engine.
Express.js - Minimal and flexible Node.js web application framework
BullMQ - BullMQ is a Node.js library that implements a fast and robust queue system built on top of Redis.

Getting Started

To get a local copy up and running follow these simple steps :

Prerequisites

To run this project, you'll need to have the following installed:

Node.js : https://nodejs.org
npm :
```
npm install npm@latest -g
```
Redis server : https://redis.io/

You can also use Redis server cloud service if you prefer.

Installation

Register at SendGrid and create an API KEY.

Clone the repo :

git clone https://github.com/PraneshASP/cryptocurrency-price-alert.git

Install dependencies (use sudo if required) :
```
npm install
```
Update project settings in the config.js file.
Start the server :
```
npm start
```