MCPcopy Index your code
hub / github.com/eifr/Vigilo

github.com/eifr/Vigilo @main

Chat with this repo
repository ↗ · DeepWiki ↗ · + Follow
34 symbols 106 edges 22 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

📸 Vigilo

"Vigilo" is Latin for "I watch over," which perfectly describes this portable security camera app.

Turn any device with a camera into a portable security system! 🛡️ This slick web app is built with Preact and Vite, leveraging powerful computer vision to keep an eye on things for you.

🚀 Installation

  1. Clone the repository: bash git clone https://github.com/eifr/Vigilo.git
  2. Navigate to the project directory: bash cd Vigilo
  3. Install the dependencies: bash bun install

📜 Available Scripts

In the project directory, you can run:

bun run dev

Runs the app in the development mode. Open http://localhost:5173 to view it in the browser. The page will reload if you make edits.

bun run build

Builds the app for production to the dist folder. It correctly bundles Preact in production mode and optimizes the build for the best performance.

bun run preview

Serves the production build locally to preview it before deploying.

🔑 Key Dependencies

  • Preact: A fast 3kB alternative to React with the same modern API.
  • Vite: A modern frontend build tool that provides an extremely fast development environment.
  • OpenCV.js: The JavaScript version of the OpenCV library for computer vision tasks.
  • qrcode.react: A React component for generating QR codes.

Extension points exported contracts — how you extend this code

TelegramSettingsProps (Interface)
(no doc)
src/components/TelegramSettings.tsx
CameraHookResult (Interface)
(no doc)
src/hooks/useCamera.ts
MotionSensitivitySettingsProps (Interface)
(no doc)
src/components/MotionSensitivitySettings.tsx
CameraListProps (Interface)
(no doc)
src/components/CameraList.tsx
TelegramSetupGuideProps (Interface)
(no doc)
src/components/TelegramSetupGuide.tsx
MotionWithOverlayProps (Interface)
(no doc)
src/components/Motion.tsx

Core symbols most depended-on inside this repo

cn
called by 14
src/lib/utils.ts
dataUrlToBlob
called by 2
src/lib/utils.ts
useTelegram
called by 1
src/hooks/useTelegram.ts
useCamera
called by 1
src/hooks/useCamera.ts
useOpenCv
called by 1
src/hooks/useOpenCv.ts
getOpenCv
called by 1
src/hooks/useOpenCv.ts
useTheme
called by 1
src/hooks/useTheme.ts
App
called by 0
src/app.tsx

Shape

Function 28
Interface 6

Languages

TypeScript100%

Modules by API surface

src/components/ui/card.tsx7 symbols
src/components/Motion.tsx3 symbols
src/app.tsx3 symbols
src/lib/utils.ts2 symbols
src/hooks/useTheme.ts2 symbols
src/hooks/useOpenCv.ts2 symbols
src/hooks/useCamera.ts2 symbols
src/components/TelegramSetupGuide.tsx2 symbols
src/components/TelegramSettings.tsx2 symbols
src/components/MotionSensitivitySettings.tsx2 symbols
src/components/CameraList.tsx2 symbols
src/hooks/useTelegram.ts1 symbols

For agents

$ claude mcp add Vigilo \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact