docs: infrastructure-style README
This commit is contained in:
parent
2bb3c6c02e
commit
e3367b602f
40
README.md
Normal file
40
README.md
Normal file
@ -0,0 +1,40 @@
|
||||
# Degelas Solar
|
||||
|
||||
Solar production forecasting SaaS platform — deployed at https://solar.degelas.be.
|
||||
|
||||
## Layout
|
||||
|
||||
```
|
||||
solar/
|
||||
├── backend/ # FastAPI server (forecast engine, metrics API)
|
||||
├── frontend/ # React + Vite dashboard (solar.degelas.be)
|
||||
├── pr-frontend/ # PR & campaign management UI (pr.degelas.be)
|
||||
├── nginx/ # Nginx config for the reverse proxy
|
||||
├── scripts/ # Cron refresh, helper scripts
|
||||
├── docs/ # Documentation
|
||||
├── history_EU/ # Historical EU market data
|
||||
├── umami-docker-compose.yml # Umami analytics stack
|
||||
├── chrome-profile/ # Browser automation profiles (local only)
|
||||
└── docker-compose.yml # Full stack orchestration
|
||||
```
|
||||
|
||||
## What's NOT in this repo
|
||||
|
||||
- `.env` — API keys, JWT secrets, DB credentials (see `.env.example`)
|
||||
- `umami.env` — Umami DB password and app secret
|
||||
- `chrome-profile/` — browser cookies and login sessions
|
||||
- `node_modules/`, `*.pyc`, `.pytest_cache/`
|
||||
|
||||
## Deploy
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
The backend exposes `/api/degelas/metrics` consumed by the grants app.
|
||||
The grants app at grants.degelas.be reaches this backend over the shared `fullstack_degelas_proxy` Docker network.
|
||||
|
||||
## Admin
|
||||
|
||||
- Platform metrics: `https://solar.degelas.be/api/degelas/metrics`
|
||||
- Analytics: https://analytics.degelas.be
|
||||
Loading…
Reference in New Issue
Block a user