Skip to content

ChiragAgg5k/suraksha-ai

Repository files navigation


Logo

SuRक्षा

The ultimate AI powered Home Security and Surveillance System

Table of Contents
  1. About The Project
  2. Built With
  3. Getting Started
  4. Prerequisites
  5. Installation

About The Project

Thumbnail

SuRक्षा is a security system powered by AI that works with current camera systems to offer sophisticated video analytics, detect threats, and provide intelligent monitoring features. The system utilizes computer vision and deep learning methods to analyze video streams, allowing for functionalities like identifying objects, tracking motion, detecting anomalies, and recognizing fires.

(back to top)

Built With

SuRक्षा is built with the following technologies:

  • Flask
  • Python
  • Firebase
  • Chart.js
  • Yolov8
  • Huggingface

(back to top)

Getting Started

To start using SuRक्षा, follow the steps below.

Prerequisites

You will need the following tools to get started:

  • Python - Follow the instructions here to install Python.

  • Poetry - A tool for dependency management and packaging in Python. You can install it using the following command:

python3 -m pip install poetry

Installation

  1. Clone the repository either using the GitHub GUI or the following command:
cd path/to/directory
git clone https://github.com/ChiragAgg5k/suraksha
cd suraksha
  1. Install the required dependencies using Poetry.
poetry shell
poetry install
pip install --force-reinstall -v "numpy==1.25.2" # fix some weird issue with krutrim
  1. Create a new Firebase project and get the required credentials. You can follow the instructions here

  2. Create a Mailtrap account and get the credentials for email notifications. You can follow the instructions here

  3. Create a .env file in the root directory and add the required credentials. Follow the .env.example file for reference.

  4. Run the application.

poetry run python -m suraksha.app

(back to top)

Features

  • Object Detection Accurately detect and identify objects in the video stream. Object Detection

  • Camera Logs View the logs of the camera and the objects detected. Camera Logs

  • Chatbot Get notifications and alerts on your phone using the chatbot. Chatbot

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

About

SuRक्षा - AI Powered Home Security and Surveillance System

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published