perception-toolkit v0.0.1

Perception Toolkit

This toolkit provides a set of components and utilities for developers to add an augmented experience to their website. For example, a primary use-case supported is the ability to detect barcodes (in -- say -- a real-world store) with the user's device camera, and to show them extended information on a given product.

Included in this toolkit is:

• Support detection
  • Barcodes
  • getUserMedia and environment camera
  • Geolocation
• Detectors
  • Barcodes
  • QR Codes
  • Geolocation
  • (TODO) Planar Image / ML Image Classification
• UI
  • Loader
  • Card
  • User onboarding
• Utilities
  • Stream capture (i.e. getUserMedia to image conversion)
  • Logging
  • Image resizing

Getting started

1. git clone https://github.com/GoogleChromeLabs/perception-toolkit
2. npm i
3. npm run build
4. npm run serve
5. Open the demo page at localhost:8080

The intended use is detailed under src/recipes, where you can see how to set up barcode detection and the display of values to the end user.

Please note: You will need to use Chrome 73+ for the native BarcodeDetector, and should enable Experimental Web Platform features.

Building

npm run build

Testing

npm test

Note: coverage data can be found in the generated coverage folder located in the project root.

API Docs

npm run docs

Note: docs can be found in the generated docs folder located in the project root.