Repository navigation
Releases
Releases · calmrat/krypto-explorer
Krypto Explorer - Simple UI for exploring Crypto Tokens
📌 Project Title: Simple Crypto Coin Explorer
🔧 Purpose
To provide a user-friendly API and frontend UI for managing a list of cryptocurrencies, verifying them using the CoinGecko API, and automatically updating metadata when stale. The system should be containerized and scalable using Docker.
🧩 Components
1. API Backend (FastAPI)
Responsibilities:
- CRUD for crypto records (Create, Read, Update, Delete)
- Endpoint to trigger manual metadata refresh
- Background task to update stale metadata
- Redis caching layer for performance
- CoinGecko integration for symbol validation + metadata
Example Routes:
POST /cryptos/– Create a new recordGET /cryptos/{symbol}– Get crypto infoPUT /cryptos/{symbol}– Update recordDELETE /cryptos/{symbol}– Delete recordPOST /cryptos/refresh– Refresh metadata
2. Frontend UI (Streamlit)
Responsibilities:
- Display list of crypto records
- Allow creating/updating/deleting records
- Trigger metadata refresh
- Show stale status indicators
3. Metadata Verification & Update (CoinGecko API)
Responsibilities:
- Validate that a symbol exists in CoinGecko
- Pull metadata like name, market cap, price, logo, etc.
- Update stale metadata automatically (e.g., every 24 hours or on demand)
4. Database (PostgreSQL + SQLAlchemy ORM)
Responsibilities:
- Store crypto records with fields like:
symbolnamelogo_urlmarket_capprice_usdlast_updated
- Handle relationships and queries via SQLAlchemy
5. Caching Layer (Redis)
Responsibilities:
- Store temporary CoinGecko API responses
- Track which crypto records are stale
- Speed up response times for common queries
6. Docker Deployment
Responsibilities:
- Containerize API, UI, DB, Redis
- Use Docker Compose for easy orchestration
Key Files:
Dockerfilefor FastAPIDockerfilefor Streamlit UI (optional)docker-compose.ymlincluding:- FastAPI
- Streamlit
- PostgreSQL
- Redis
Full Changelog: https://github.com/calmrat/krypto-explorer/commits/v0.1.0