synycboom / folks-finance-loan-notification

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

folks-finance-loan-notification

A notification system where users can set triggers for when they should be notified that their loan is close to being liquidated. It leverages Folks Finance JS SDK. This is a bounty project from https://gitcoin.co/issue/folks-finance/folks-finance-js-sdk/2/100028562

  • Allow users to connect their Discord/Telegram and use them as notification channels

Project Architecture

architecture

Demo Video

Demo Link

Development

Setup environment files by copying .env.example and edit the variables

$ make prepare.env

Setup nodejs dependencies

$ make prepare.node

Run dependencies (zookeeper, kafka, mongodb) in background

$ make deps.up

Create a Kafka topic

$ make prepare.topic

Run monitor-service locally

$ make monitor.up

Run notifier-service locally

$ make notifier.up

Run user-setting-service locally

$ make user-setting.up

Run web application locally

$ make app.up

About

License:MIT License


Languages

Language:TypeScript 89.4%Language:HTML 4.6%Language:Shell 2.0%Language:Makefile 1.6%Language:Dockerfile 1.5%Language:CSS 0.5%Language:JavaScript 0.4%