← Back to home

Getting Started

1. Choose your deployment

Decide between a single-host container runtime (Podman/Docker + Compose) or a Kubernetes/OKD cluster for production.

See INSTALLATION.md for step-by-step instructions.

2. Configure PostgreSQL

Each enterprise deployment uses its own PostgreSQL database via DATABASE_URL. Point the app at your managed database or containerized Postgres.

3. Seed an organization

Create your first user and organization, then configure facilities and suppliers to begin capturing activity data.

Features

Activity Data

Capture raw activity for waste, water, fuel, electricity, installations, marketing initiatives, and supply-chain emissions. Each record is time-bounded and facility-aware.

Emissions Calculation

Link activity data to emission factors and record immutable emission results, tagged by scope, category, and methodology.

Reports

Generate reports (annual summaries, ESG, CSRD, TCFD) and associate them with the underlying activity and emission records for traceability.

Searchable Metrics

A search index lets you query and filter metrics across time, facilities, suppliers, and categories.

Compliance & Audit

Audit-ready data model

The schema is designed so every emission result can be traced back to raw activity, emission factors, and the report that used it.

Append-only logs

Audit logs record who did what and when, including resource changes, IP, and user agent, to support internal and external reviews.

Upcoming Features

  • Interactive activity input UI with dropdowns and calendars.
  • Role-based dashboards for admins, members, and suppliers.
  • Report linking for explicit activity/emission ↔ report joins.
  • Supply-chain specific workflows and invitations for vendors.

Integrations

Data sources

CSV uploads, manual entry, APIs, and future AI-assisted input flows will all land in the same `RawActivityData` table.

Infrastructure

OCI images compatible with Podman, Docker, containerd, and deployable on OKD/OpenShift or any Kubernetes cluster.

Roles & Dashboards

Organization roles

Use OrganizationUser.role to define admins, members, suppliers, and read-only users, each with tailored dashboards.

Trickle-up reporting

Activity and emissions can be scoped to facilities or suppliers, but reports and dashboards aggregate naturally at the organization level.

Resources

Architecture

See ARCHITECTURE.md for monorepo layout, public sites, and deployment topology.

Installation

See INSTALLATION.md for enterprise setup and ENV_SETUP.md for environment variables.

Next steps

See NEXT_STEPS.md for the implementation roadmap around containerization, demo pages, and UI components.