This commit is contained in:
@@ -0,0 +1,41 @@
|
||||
# Ekklesia
|
||||
|
||||
Ekklesia is an open, modular church technology platform for composing backend capabilities
|
||||
into independently developed dashboards, websites, mobile apps, kiosks, displays, and other
|
||||
surfaces.
|
||||
|
||||
## Current status
|
||||
|
||||
Phase 1 establishes the repository foundation only. It includes reproducible workspace
|
||||
tooling, strict TypeScript defaults, executable architectural boundary checks, tests, CI, and
|
||||
local PostgreSQL/S3-compatible infrastructure. Core runtime, module discovery, identity,
|
||||
Module SDK, surfaces, and feature modules intentionally begin in later phases.
|
||||
|
||||
## Quick start
|
||||
|
||||
Prerequisites: Node.js 24 LTS, pnpm 11.12, and Docker with Compose.
|
||||
|
||||
```bash
|
||||
pnpm install --frozen-lockfile
|
||||
cp .env.example .env
|
||||
pnpm infrastructure:up
|
||||
pnpm verify
|
||||
```
|
||||
|
||||
The development services bind only to loopback:
|
||||
|
||||
- PostgreSQL: `127.0.0.1:5432`
|
||||
- S3-compatible object storage: `127.0.0.1:8333`
|
||||
|
||||
The values in `.env.example` are development-only and must never be reused in a deployed
|
||||
environment.
|
||||
|
||||
## Architecture
|
||||
|
||||
- [Platform architecture](docs/architecture/platform-architecture.md)
|
||||
- [Repository boundaries](docs/architecture/repository-boundaries.md)
|
||||
- [Repository workflow](docs/development/repository-workflow.md)
|
||||
- [Architecture decisions](docs/architecture/decisions/README.md)
|
||||
|
||||
No open-source license has been selected yet. A license should be added only after the project
|
||||
owner makes that decision.
|
||||
Reference in New Issue
Block a user