API for the SmartSight app
Branch: dev
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api
config
engine @ b93910d
helpers
logs
test
.editorconfig
.env.sample
.gitignore
.gitmodules
.travis.yml
LICENSE
README.md
app.js
package.json
server.js

README.md

SmartSight API

API for the SmartSight app

License: GPL v3 js-standard-style Build Status

SmartSight is an Android app powered by a deep learning engine that provides information about any object scanned by the device’s camera.

Documentation

Please refer to our 📚 Wiki documentation.

Getting started

  • Clone the repo and its submodule: git clone --recursive https://github.com/smartsight/smartsight-api.git
  • Install Python 3
  • Install Python requirements: pip install -r engine/requirements.txt
  • Set your Python 3 path
    • Duplicate the file .env.sample
    • Rename it .env
    • Change the SM_PYTHON_PATH value to your Python 3 interpreter (run which python3 in the command line to know it)
  • Install Node dependencies: npm install
  • Run the server: npm start
  • Listening on: http://0.0.0.0:3000

Development setup

Environment

Variable Default Description
SM_SERVER_HOST "0.0.0.0" Address of the server
SM_SERVER_PORT 3000 Port of the server
SM_MODEL_DIR "/tmp/smartsight" Directory to store the classification graph
SM_PYTHON_PATH "" Path to the Python 3 interpreter

To change these environment variables, duplicate the file .env.sample, rename it .env and change the default values if necessary.

Commands

  • Watch: npm run dev
  • Lint: npm run lint
  • Fix lint: npm run lint:fix
  • Test: npm test

License

GPL © SmartSight