Sharingan

A Real-Time object detection app, built with Electron, and Tensorflow.js.

Prerequisites • Installation • Run & Package • License

Prerequisites

• Git is need to clone repository on your machine.
• npm is needed to install packages.
• Node.js is needed to run Sharingan.

Ubuntu

Install git, Node.js and npm on your machine running Ubuntu:

$ sudo apt-get install git-core
$ sudo apt install nodejs
$ sudo apt install npm

Windows

Use the official links for downloading on Windows:

• Git
• Node.js
• npm

Run the following commands to confirm if the installation was successful:

$ git --version
$ node --version
$ npm --version 

Installation

Clone the repo and cd into the directory:

$ git clone https://github.com/shashwatah/sharingan.git
$ cd sharingan 

Then install the node-modules in package.json:

$ npm install

Run & Package

Run the app with the following command:

$ npm start

Package the app with electron-packager:

For Windows:

$ npm run package-win

For Linux:

$ npm run package-linux

For Mac:

$ npm run package-mac

License

MIT License | Copyright (c) 2024 Kumar Shashwat