half-orm-gen

⚠️ Alpha — not for production.
This project is under active development. APIs, generated code structure, and CLI commands may change without notice between releases. Do not use in production environments.

A halfORM extension that generates a Litestar REST API and a frontend backoffice (SvelteKit 5 or Angular) from your half-orm-dev project.

Installation

pip install half-orm-gen

API

half_orm gen api --litestar
litestar --app ho_api/app:application run --reload

Frontend backoffice

# SvelteKit 5
half_orm gen frontend --svelte
cd ho_frontend/svelte && npm install && npm run dev

# Angular
half_orm gen frontend --angular
cd ho_frontend/angular && npm install && npm start

Contributing

We are looking for contributors with expertise in:

• Angular — improve generated components, routing, and state management
• SvelteKit — improve generated stores, layouts, and page components
• Litestar — improve the dynamic runtime, middleware, and OpenAPI integration

See CONTRIBUTING.md for how to set up a development environment and the areas where help is most needed.

Documentation

Authentication

• Overview — authentication vs authorization, env vars, file map
• Local authentication — identity.user, local_auth.py, HS256/RS256 signing
• Federation — sharing identities across independently-deployed peers

Backend

• Authorization — JWT, roles, /ho_access, /ho_setup
• CRUD access — access model, verbs, field access, @ho_api_filter, @tools.api_*
• What goes in a relation class — class vs. ho_api/custom/, the escape hatch

Frontend (shared)

• Generated frontend code — file layout, regenerated vs scaffolded
• ResourceSilo reference — full reactive API, one silo per app
• AuthService / AuthState reference — session, WS, simulation, route guards

Angular

• Access control — reactive buttons, FK auto-resolve, dynamic roles, simulation

Svelte

• Access control — reactive buttons, FK auto-resolve, dynamic roles

Internals — half-orm-gen's own implementation, for maintaining/extending the generator itself

• Litestar architecture — runtime, CRUD_ACCESS, role system, WebSocket
• Frontend architecture — silo pattern, access map, live updates
• Angular silo architecture — signals, data flow, deduplication
• Svelte silo architecture — runes, data flow, deduplication

See also

• half-orm — the PostgreSQL ORM at the core
• half-orm-dev — the development framework