Skip to main content

README.md

![Gleam Lightspeed](https://radicle.noumena.mx/raw/rad:z3YgcTxjgNbDG7b9ME7jRqR5Cxr4A/9156a1e9ef3eba8621b3c456419f2d2759d545c2/lightspeed-1024.png)

**Lightspeed** is a production-ready, LiveView-style web framework for Gleam.

It is built for teams that want typed realtime UI, deterministic runtime
behavior, and first-class data/ETL operations on the BEAM.

## Why Lightspeed

- server-owned session lifecycle with typed event handling
- deterministic patch protocol and transport contracts
- typed boundaries for forms, uploads, async, channels, and presence
- integrated data pipeline and ETL operations surface
- tenant policy isolation and auditable control loops
- release certification path enforced by `make production-ready`

## Status

- stable GA baseline established in `1.0.0`
- current release: `1.1.0`
- production-readiness certification is part of the default release flow

## Install

```sh
gleam add lightspeed
```

## Try Now

From this repository:

```sh
make setup
make check
make test
```

Run the production release gate:

```sh
make production-ready
```

Run the integrated ETL operations fixture surface:

```sh
make pipeline-operations-surface-fixture
```

## Documentation

Start with the docs portal:

- `docs/README.md`

Key paths:

- getting started and architecture:
  - `docs/developer_guide.md`
  - `docs/architecture.md`
- framework/runtime:
  - `docs/component_migration_examples.md`
  - `docs/client_js_command_compat.md`
  - `docs/transport_compatibility_progressive_enhancement_expansion.md`
- data and ETL:
  - `docs/data_pipeline_core.md`
  - `docs/etl_reliability_slo_gate.md`
  - `docs/integrated_data_pipelines_etl_runtime_operations_surface.md`
- production operations:
  - `docs/production_blueprint.md`
  - `docs/production_readiness_checklist.md`
  - `docs/operator_runbook.md`
- compatibility and upgrades:
  - `docs/compatibility_matrix_1.0.0.md`
  - `docs/upgrade_0.1.0-rc_to_1.0.0.md`
- release history:
  - `CHANGELOG.md`

## Repository Layout

```text
.
├── src/lightspeed/         # framework/runtime modules
├── test/                   # Gleam test suites
├── client/                 # browser runtime and JS interop layer
├── docs/                   # guides, operations, and compatibility docs
├── specs/                  # normative specifications
├── rfcs/                   # request-for-comments documents
├── adrs/                   # architecture decision records
├── examples/               # usage examples
└── Makefile                # local and CI entrypoints
```

## Community

- contribution guide: `CONTRIBUTING.md`
- code of conduct: `CODE_OF_CONDUCT.md`
- security policy: `SECURITY.md`
- support channels: `SUPPORT.md`

## Versioning

Lightspeed follows semantic versioning.

- public API and protocol stability is enforced for stable versions
- breaking changes require a major version and migration notes
- all code changes require both an RFC and an ADR

## License

Lightspeed is distributed under The Unlicense. See `LICENSE.md`.