javadandCursor
b93ecf1691
Keep source, config, and deploy files. Leave runtime data, uploads, and logs out of git. Co-authored-by: Cursor <cursoragent@cursor.com>
43 lines
867 B
Markdown
43 lines
867 B
Markdown
# Kamidso API
|
|
|
|
Intelligent data assistant. Product notes: [KAMIDSO.md](./KAMIDSO.md).
|
|
|
|
The web UI is a separate repository. This repository is only the API.
|
|
|
|
## Run
|
|
|
|
```bash
|
|
docker compose -f docker/kamidso/docker-compose.yml up -d
|
|
cp .env.example .env
|
|
```
|
|
|
|
```powershell
|
|
.\scripts\start-backend.ps1
|
|
```
|
|
|
|
API: http://127.0.0.1:5670
|
|
|
|
Full local containers (Mongo + API):
|
|
|
|
```bash
|
|
docker compose up --build -d
|
|
```
|
|
|
|
## Check
|
|
|
|
```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`)
|
|
|
|
## Docs
|
|
|
|
- [Architecture](docs/kamidso/ARCHITECTURE.md)
|
|
- [Layout](docs/kamidso/REPO_LAYOUT.md)
|
|
- [Development](docs/kamidso/README.md)
|
|
- [Deploy](docs/kamidso/COOLIFY.md)
|
|
|
|
Not in git: `data/` (uploads, vectors, runtime files), `logs/`, `.env`, and virtualenvs.
|