Skip to content

taufanAli65/SENTRY

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 

Repository files navigation

SENTRY: Smart Warehouse Monitoring System

This project is designed to monitor employee and item movement within a warehouse using face recognition and weight sensors. It aims to improve security, ensure accurate inventory records, and detect potential theft or data inconsistencies.

Key Features

  • Automatic employee detection using face recognition
  • Monitoring item check-in and check-out
  • Weight tracking via shelf-mounted sensors
  • Notifications for missing items or suspicious activity

Team Members

Technologies Used

  • Python / Node.js (Backend)
  • Vue.js (Web Frontend)
  • Flutter (Mobile Apps)
  • MongoDB (Database)
  • Etc.

System Overview

Employees are recognized through a face recognition system when entering or exiting the warehouse. Items are scanned during both check-in and check-out, and shelf sensors track weight changes. The system compares scanned data with real-time sensor input to ensure consistency. If any mismatch is detected, the system sends a notification and logs the suspicious activity.

System Flowchart

System Flowchart

Contribution Guidelines

Commit Message Rules

  • Use Conventional Commits format:
    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation changes
    • style: for formatting, missing semi colons, etc.
    • refactor: for code changes that neither fixes a bug nor adds a feature
    • test: for adding or updating tests
    • chore: for maintenance tasks
  • Example:
    feat: add face recognition module
    docs: update system overview and flowchart
    fix: correct sensor data parsing bug
    

When to Commit

  • Commit after completing a logical unit of work (e.g., a feature, bug fix, or documentation update).
  • Avoid committing unfinished or broken code to shared branches.
  • Write clear, concise commit messages describing the change.

Branch Naming Convention

  • Use lowercase and hyphens.
  • Follow the project branch structure for naming:
    • For API development: api/feature-name (merged into api-stable)
    • For Mobile development: mobile/feature-name (merged into mobile-stable)
    • For Web development: web/feature-name (merged into web-stable)
    • For Machine Learning: use machine-learning branch for all ML-related work
    • For IoT: use iot branch for all IoT-related work
  • For general features, fixes, docs, or refactorings, use the format:
    • feat/feature-name, fix/bug-description, docs/doc-topic, refactor/area
  • Use descriptive names for the rest of the branch.

Project Branch Structure

  • api-stable: API code that is ready for production.
    • Must contain: Up-to-date API documentation (README.md or docs/api.md), OpenAPI/Swagger specs if available, environment sample files, and tested production-ready code.
  • For every API development, use: api/feature-name
  • mobile-stable: Stable version of the mobile app.
    • Must contain: Mobile usage guide (README.md), screenshots or demo, environment sample files, and tested production-ready code.
  • For every mobile development, use: mobile/feature-name
  • web-stable: Web code that is ready for production.
    • Must contain: Web deployment instructions (README.md), screenshots or demo, environment sample files, and tested production-ready code.
  • For every web development, use: web/feature-name
  • machine-learning: For machine learning related code or assets.
    • Must contain: Model documentation (README.md), dataset/sample links, training/evaluation scripts, and usage instructions.
  • iot: For IoT related code or assets.
    • Must contain: Hardware setup guide (README.md), wiring diagrams, firmware upload instructions, and tested code/assets.

Pull Requests

  • Create a pull request (PR) for merging changes into the appropriate project branch (e.g., api-stable, mobile-stable, web-stable, machine-learning, or iot), not directly into main.
  • Ensure your branch is up to date with the latest target branch before creating a PR.
  • Add a clear description of what your PR changes and why.

General Workflow

  1. Create a new branch from main using the appropriate naming convention.
  2. Make your changes and commit them with proper messages.
  3. Push your branch to the remote repository.
  4. Open a pull request for review and merging.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published