Documentation
Getting started
Installation
Updated 2026-11-03
Installation
Today: developer setup
The repository is installed like a standard Laravel application plus a Flutter client. Follow Quick start.
Planned: turnkey installer
The kit completion plan includes an installer that provisions the full stack on a clean Ubuntu or Debian host:
- OS packages, PHP-FPM, MySQL, Nginx and TLS
- Node and the Flutter/Android build toolchain
- queue worker and scheduler
- optional AI services (Ollama, Stable Diffusion Forge, rembg)
- database, theme, admin user and demo content
- backups, health check and a golden-path smoke test
Three editions are planned:
| Edition | What it is |
|---|---|
| Native | Everything installed on the host |
| Docker | Fully containerized stack |
| Hybrid | Native core + containerized AI services |
The installer is planned; it is not part of the current release. The documentation will be updated with the exact commands when it ships.
What the installer will not do
- It will not choose your production domain or TLS certificate without confirmation.
- It will not send your data to an external service.
- It will not overwrite an existing database.
- It will not skip the backup and rollback steps.
Client build
The Flutter client is built from flutter/:
cd flutter
flutter pub get
flutter analyze
flutter test
flutter build apk --debug
Point the client at your API with the build configuration (API_BASE_URL) and connect it to your server.
Updates
kit:update is planned: it will take a backup, apply code and migrations, rebuild assets and keep a rollback point. Security fixes are always included in the update policy.