docs: initial README

This commit is contained in:
gdegelas 2026-06-01 09:50:05 +00:00
parent c690f01dd2
commit 29830ca69a

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# TRON Parity Ladder
Price parity and market-cap flip ratio dashboard for the TRON ecosystem — deployed at https://tron.degelas.be.
## Layout
```
tron/
├── src/ # React + Vite frontend (Vite SPA)
│ └── services/ # Binance API, OHCV store, history store
├── index.html # Entry point with Umami analytics snippet
├── public/ # Static assets (favicon, og-image, manifest, robots, sitemap)
├── docker/ # Nginx config for production
├── Dockerfile # Multi-stage: builder → nginx
└── docker-compose.yml # Served by nginx on port 8080
```
## What's NOT in this repo
- `.env` — runtime config (see `.env.example`)
- `node_modules/`, `dist/`
## Deploy
```bash
docker compose up --build -d
```
## Admin
- Umami analytics: https://analytics.degelas.be (website id for tron.degelas.be)