01. Get Started¶
Purpose of this Documentation¶
This documentation covers the AClimate v3 platform — a modular ecosystem for agro-climatic data management, processing, and visualization. It serves as the single source of truth for developers, data engineers, operations teams, and product stakeholders.
What This Documentation Covers¶
- System Architecture: Component relationships, deployment model, integration points
- Data Model: Complete entity catalog, relationships, and database conventions derived from aclimate_v3_orm
- API Contracts: Endpoint specifications, authentication, request/response schemas
- ETL Pipelines: Data processing workflows, orchestration, quality controls
- Frontend: User interface architecture, state management, configuration
- Admin: Administrative portal for system configuration and management
- Keycloak: Centralized authentication and authorization
- GeoServer: Spatial data services and map layers
- Dev Experience: Local setup, coding standards, testing strategies
Target Audiences¶
| Audience | Focus Areas |
|---|---|
| Developers | API contracts, ORM models, setup guides, dev standards |
| Data Engineers | ETL pipelines, data quality, ORM conventions |
| DevOps / Ops | Deployment, CI/CD, monitoring, runbooks |
| Product / Admin | Admin portal features, configuration, operational flows |
How to Navigate¶
If you are new to AClimate v3, we recommend the following reading order:
- Architecture — Understand the big picture: repos, components, and their interactions
- Data Model — Explore the ORM entities as the foundation of the system
- API — Learn how data is exposed through endpoints
- ETL Pipeline — Understand data flows from ingestion to consumption
- Frontend — See how end users interact with the platform
- Admin — Learn how to configure and manage the system
- Dev Experience — Get your local environment ready
Relationship to Previous Version¶
This documentation for AClimate v3 follows the same base structure of the previous version, maintaining consistency of sections, navigation, detail level, and editorial style. New v3 sections are added respecting that organization.