Skip to content

Krypto Explorer - Simple UI for exploring Crypto Tokens

Pre-release
Pre-release

Choose a tag to compare

@calmrat calmrat released this 10 Apr 08:51
· 3 commits to main since this release

📌 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 record
  • GET /cryptos/{symbol} – Get crypto info
  • PUT /cryptos/{symbol} – Update record
  • DELETE /cryptos/{symbol} – Delete record
  • POST /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:
    • symbol
    • name
    • logo_url
    • market_cap
    • price_usd
    • last_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:

  • Dockerfile for FastAPI
  • Dockerfile for Streamlit UI (optional)
  • docker-compose.yml including:
    • FastAPI
    • Streamlit
    • PostgreSQL
    • Redis

Full Changelog: https://github.com/calmrat/krypto-explorer/commits/v0.1.0