wito/uphold
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
Vítor Vieira 2025-11-28 20:34:29 +00:00
parent 565c2ffe26
commit 93ee527084
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,11 +1,9 @@
# Uphold currency rate bot for interview # Uphold currency rate bot for interview
This project includes a simple API to checkout statistics and health monitoring (requires running DB)
## Requirements ## Requirements
- Node.js >= v20 - Node.js >= v20
- Docker and Docker Compose (optionally, Podman and Podman compose ) - Docker and Docker Compose (optionally, Podman and Podman compose)
- PostgreSQL (optional, runs in-memory without it) - PostgreSQL (if running outside of Docker)
## Quick Start ## Quick Start
@ -139,10 +137,10 @@ curl http://localhost:3000/alerts?limit=100
- `index.js` - Entry point - `index.js` - Entry point
- `src/bot.js` - Bot logic - `src/bot.js` - Bot logic
- `src/api.js` - Uphold API client - `src/api.js` - Uphold API client
- `src/db.js` - PostgreSQL persistence layer - `src/db.js` - DB logic
- `src/logger.js` - Simple logging - `src/logger.js` - Simple logging
- `src/server.js` - API server for docker diagnosis - `src/server.js` - API server for docker diagnosis
- `src/stats.js` - Runtime statistics tracking - `src/stats.js` - Statistics tracking
- `tests/bot.test.js` - Tests - `tests/bot.test.js` - Tests
## Stopping the Bot ## Stopping the Bot