Oko

Fully local home security system

Prerequisites

OpenCV (see opencv-rust/INSTALL.md)

Scripts

./make.sh run           # Default admin password: "hunter42"

./make.sh f             # Run frontend in dev mode
./make.sh b             # Run backend in dev mode

./make.sh seed          # Seed DB with dummy data
./make.sh cam1          # Send dummy camera images

./make.sh t             # Run tests
./make.sh coverage

License

This project is licensed under the GNU GPL v3.0.

Made using the following resources:

Resource	License
axum-login example code	MIT
Axum example code	MIT
video2image	N/A1
Vite PWA Svelte template	MIT
Svelte ESLint example config	MIT
Svelte Prettier example config	MIT
Playwright-rust README	MIT
Testing Library setup	MIT
Vitest mocking example	MIT
opencv-rs example code	MIT
tungstenite examples	MIT
shadcn Blocks	MIT
ESP32-CAM example code	GNU LGPLv2.1
ArduinoWebsockets examples	GNU GPLv3.0
ESPAsyncWebServer examples	GNU LGPLv3.0
Lucide icons	ISC
esp-idf-template examples	MIT
esp-rs/std-training	MIT
esp-idf-svc examples	MIT
edge-net examples	MIT
gatekeeper source code	Unlicense
esp-camera-rs package fork	MIT

Footnotes

1. "...this solution can be customized to suit your particular requirements. Don’t hesitate to make adjustments and employ this code according to your video-to-image conversion needs." ↩