kjannette/koin_ping_0.2.0

Files

KS Jannette 0adfd70853 first commit of refactor

2026-02-27 09:58:18 -05:00

1.1 KiB

Raw Blame History

Koin Ping Backend

On-chain monitoring and alerting system backend.

Environment Variables

Create a .env file in the backend directory with the following variables:

PORT=3001
NODE_ENV=development

# PostgreSQL Database Configuration
DB_HOST=localhost
DB_PORT=5432
DB_USER=your_db_user
DB_PASSWORD=your_db_password
DB_NAME=koin_ping

# Blockchain RPC Endpoints (examples)
ETH_RPC_URL=https://mainnet.infura.io/v3/YOUR_INFURA_KEY
POLYGON_RPC_URL=https://polygon-rpc.com

# Polling Configuration
POLL_INTERVAL_MS=10000

Getting Started

Install dependencies:
```
npm install
```
Set up your .env file with the required environment variables
Run the development server:
```
npm run dev
```
Run in production:
```
npm start
```

Project Structure

api/ - API endpoints and server configuration
poller/ - Blockchain polling logic
alerts/ - Alert evaluation and management
notifications/ - Notification delivery system
domain/ - Domain models and business logic
infra/ - Infrastructure (database, external services)
shared/ - Shared utilities and helpers