- "engine/pyproject.toml" - "engine/main.py" - "engine/.gitignore" - "README.md" GSD-Task: S01/T01
26 lines
623 B
Markdown
26 lines
623 B
Markdown
# Kerf
|
|
|
|
Modular raster-to-vector conversion engine + 2D sign/patch design canvas.
|
|
|
|
## Repository Structure
|
|
|
|
```
|
|
engine/ — Kerf Engine (standalone API, Python/FastAPI)
|
|
app/ — Kerf App frontend (React) [future]
|
|
server/ — Kerf App backend API [future]
|
|
docker/ — Dockerfiles and compose configs [future]
|
|
```
|
|
|
|
## Kerf Engine
|
|
|
|
The engine is a self-contained FastAPI service that accepts raster images and returns clean vector output (SVG, DXF).
|
|
|
|
### Quick Start
|
|
|
|
```bash
|
|
cd engine
|
|
pip install -e ".[dev]"
|
|
uvicorn main:app --host 0.0.0.0 --port 8000
|
|
```
|
|
|
|
API docs available at `http://localhost:8000/docs`.
|