-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3a40be3
commit 437e906
Showing
1 changed file
with
26 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,44 @@ | ||
| # Ninety Camera - Smart Monitoring Platform for Security Cameras | ||
|
|
||
| Ninety Camera is a smart monitoring platform for security cameras which can detect human intrusions from camera footage and notify users about the intruder. The whole system is come up with a desktop application, mobile applicatin and a web application. This is the frontend of the desktop application. | ||
|
|
||
|  | ||
|  | ||
|  | ||
|
|
||
| Ninety Camera is a smart monitoring platform for security cameras which can detect human intrusions from camera footage and notify users about the intruder. The whole system is come up with a desktop application, mobile applicatin and a web application. This is the frontend of the desktop application. | ||
| By using this application you can connect to CCTV cameras. Currently following CCTV cameras are supported. | ||
| - Web Cameras | ||
| - IP cameras | ||
|
|
||
| Users can view the live feed of the CCTV cameras. And view the previous intrusions. In addition to that users are able to view the recorded videos of the cameras. Only one user is able to login to this system. To run this system both flask-backend and the web-server needs to be run. | ||
|
|
||
| ## Main functionalities | ||
| - Sign in and sign up functions. | ||
| - Password forgot functions. | ||
| - Camera adding functions. (users can add both web camera's and ip camera's) | ||
| - Users can view the camera footages which connected to the system. | ||
| - Users can change the detection mode for all the cameras or for selected one camera. | ||
| - View the intrusion details and further we are showing the intrusion images and video playing option. | ||
| - View the processed video details and video view functions. Also users can view the processed videos using the date. | ||
| - Add subcriber option. Application will provide a QR code and then mobile users can scan it and add as a subcriber. | ||
|
|
||
|
|
||
| ## Technologies used | ||
| - Electron JS | ||
| - React JS | ||
| - MUI as the UI library | ||
| - Formik as the form library | ||
| - Yup for value validation | ||
|
|
||
| ## Setup | ||
| - Clone the Repository | ||
| - Run `npm i` to install the required packages | ||
| - Install the dev dependencies in the package.json using `npm install --save-dev <package-name>` | ||
| - Dev dependencies that used in the project | ||
| - Run `npm run dev` to run the package | ||
|
|
||
| ## Commands need to run before executing the project | ||
| ```js | ||
| npm i -D electron electron-is-dev | ||
| ``` | ||
| ```js | ||
| npm i -D concurrently wait-on | ||
| ``` | ||
| ## Bulding | ||
| - In the build-app branch all the configurations are setup for the building process. | ||
| - Run `npm run package` to make the package of the frontend | ||
| - Run `npm run make` to make the distributable of the package | ||
|
|
||
| ### `npm run dev` Command to execute the programme | ||
|
|
||
| You can find the backend of this application in [here](https://github.com/Ninety-Camera/flask-backend) |