# Conduit Core Domain
Conduit Core Domain is a Django REST Framework backend for ingesting, processing, and serving telemetry and weather data from the **3D-FEWSNET** platform.
## π Documentation
This README covers the basics β for the full picture (architecture,
data model, every API endpoint, the ingestion pipeline, the alerts
engine, webhooks, and deployment) see the **full documentation**:
| | |
|---|---|
| π§ Overview | What Conduit is, who it's for, the stack |
| ποΈ Architecture | How the apps fit together, with diagrams |
| ποΈ Data Model | Every model, field, and relationship |
| π Auth & Authorization | JWT, API keys, rate limits, internal endpoints |
| π API Reference | Accounts Β· Telemetry Β· Ingestion Β· Alerts Β· Blog |
| π Ingestion Pipeline | How raw readings become stored measurements |
| π¨ Alerts Engine | Hydrology & livestock scoring rules |
| π‘ Webhooks | Delivery, signing, retries |
| βοΈ Configuration | Every environment variable |
| π Deployment | Docker, cron, running locally |
| π Glossary | Terms and domain vocabulary |
## Features
- REST API built with Django REST Framework
- JWT and API Key authentication
- Telemetry and weather data ingestion
- Dockerized development environment
- Environment-based configuration
- Configurable weather data aggregation (minutely, hourly, daily)
- Daily weather summaries with date range filtering
- Paginated historical weather data
- SQLite (development) and PostgreSQL (production)
## Tech Stack
- Python 3.12
- Django 6.0
- Django REST Framework
- SimpleJWT
- Docker & Docker Compose
- SQLite / PostgreSQL
- Django CORS Headers
- WhiteNoise
---
## Getting Started
### Prerequisites
- Git
- Docker Desktop (recommended)
- Python 3.12+ (for local development)
### Clone the Repository
```bash
git clone
github.com
cd conduit-core-domain
```
---
## Environment Variables
Create a `.env` file inside the `config` directory:
```text
config/
βββ .env
```
Exam β¦