Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

303COM/README.md

Go to file
 
 
Cannot retrieve contributors at this time
303COM Personal Project Research Question Install Prerequisite Close Source Code Install Dependencies Starting the System Viewing Logs Clearing Logs Development Environment Monitor Source Changes Development Webcam
76 lines (49 sloc) 1.85 KB
Raw Blame
Open in GitHub Desktop

303COM Personal Project

🔒 A modern home security system capable of real-time threat detection


Research Question

Are Home CCTV Security Systems able to provide useful real-time Threat Alerts by combing Motion Detection and Facial Recognition?

Install

Prerequisite

To run this project you must have the required prerequisites:

Close Source Code

git clone https://github.coventry.ac.uk/eggintod/303COM.git

Install Dependencies

npm i

Sit back and have a cuppa ☕ this may take some time, OpenCV will take some time to build in your node_modules folder.

Starting the System

npm run start

The Docker docker demon should be running so MongoDB instances can be created.

Viewing Logs

npm run logs:view

Logs are written to /logs/events.log,

Clearing Logs

npm run logs:clear

Development Environment

This project is released under the MIT license. Feel free to do ask you wish. You may fine some of the following tips useful while hacking around inside this source code:

Monitor Source Changes

npn run start:dev

Starts the system using nodemon, a helping hand that watched for changes to *.js files and restarts your node for you.

Development Webcam

npm run start:dev:webcam

Attach your bult-in webcam to the system.