javadandCursor
b93ecf1691
Keep source, config, and deploy files. Leave runtime data, uploads, and logs out of git. Co-authored-by: Cursor <cursoragent@cursor.com>
45 lines
1.0 KiB
Markdown
45 lines
1.0 KiB
Markdown
# Kamidso
|
|
|
|
Data assistant with an in-process execution engine.
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
docker compose -f docker/kamidso/docker-compose.yml up -d
|
|
cp .env.example .env
|
|
```
|
|
|
|
```powershell
|
|
.\scripts\start-backend.ps1
|
|
```
|
|
|
|
The UI is the frontend repository. Open http://localhost:5173 when that dev server is running.
|
|
|
|
## Check what's running
|
|
|
|
```powershell
|
|
.\scripts\status.ps1
|
|
```
|
|
|
|
- `status=ready` — API, MongoDB, and the engine are up
|
|
- `status=degraded` — API is up; engine or database needs a look (`engine.error`)
|
|
|
|
## Documentation
|
|
|
|
- [Architecture](docs/kamidso/ARCHITECTURE.md)
|
|
- [Repository layout](docs/kamidso/REPO_LAYOUT.md)
|
|
- [Development runbook](docs/kamidso/README.md)
|
|
- [Deploy](docs/kamidso/COOLIFY.md)
|
|
|
|
## Map
|
|
|
|
| Path | Purpose |
|
|
|------|---------|
|
|
| `kamidso/` | Product API and execution engine |
|
|
| `configs/kamidso/` | Product config |
|
|
| `configs/engine.toml` | Default engine config |
|
|
| `tests/kamidso/` | Product tests |
|
|
| `.env.example` | Env template (copy to `.env`) |
|
|
| `docker/kamidso/` | Local Mongo |
|
|
| `data/` | Runtime files. Not in git |
|