https://github.com/howlowck/train-faces

UI for training faces for Microsoft Cognitive Services Face API
https://github.com/howlowck/train-faces

cognitiveservices microsoft react

Last synced: about 2 months ago
JSON representation

UI for training faces for Microsoft Cognitive Services Face API

• Host: GitHub
• URL: https://github.com/howlowck/train-faces
• Owner: howlowck
• License: mit
• Created: 2017-03-05T00:12:54.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-12-05T20:59:10.000Z (about 7 years ago)
• Last Synced: 2024-11-01T14:51:38.980Z (about 2 months ago)
• Topics: cognitiveservices, microsoft, react
• Language: JavaScript
• Homepage: https://howlowck.github.io/train-faces/
• Size: 1.42 MB
• Stars: 15
• Watchers: 2
• Forks: 9
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cognitive Services Face API Training [![Build Status](https://travis-ci.org/howlowck/train-faces.svg?branch=master)](https://travis-ci.org/howlowck/train-faces)

![screenshot](https://howlowck.github.io/train-faces/imgs/identify-screenshot.png)

The goal of this project is to create a dashboard for users to manage and test their [Cognitive Services Face API](https://www.microsoft.com/cognitive-services/en-us/face-api), given that they have a Face API Key

## Features

* Manages your Person, Person Group, and Training of your Face API

* Locally Storing your Face API Key

* Nicely formated User Data for the Person entities

* Quickly submit Face entities using the webcam

## Getting Started

You can go to the [Live App](http://aka.ms/trainfaces).

Or if you want to Spin up your own instance of this app, you will need `node`, `npm` or [`yarn`](https://yarnpkg.com/en/):

1. clone this repository

2. run `npm install` (this will take a little while)

3. run `yarn start` OR `yarn run compile` and serve the assets in the `dist` directory

4. go to [`http://localhost:3000`](http://localhost:3000)

----

## Technical Details

### Key Application Dependencies

#### ~~Backend~~ This app is now serverless :)

* ~~[express](https://expressjs.com/) (Server)~~

* ~~[project-oxford](https://github.com/felixrieseberg/project-oxford) (Face API Client)~~

#### Frontend

* [react](https://www.npmjs.com/package/react) (View Layer)

* [redux](https://www.npmjs.com/package/redux) (App State Management)

* [react-router](https://www.npmjs.com/package/react-router) (Router for React)

* [redux-thunk]((https://www.npmjs.com/package/react-router) (Redux Async Management)

* [antd](https://www.npmjs.com/package/antd) (React Component Library)

* [react-json-tree](https://www.npmjs.com/package/react-json-tree) (Render Json Tree)

* [react-ace](https://www.npmjs.com/package/react-ace) (AceEditor for react)

* [lodash.get/set](https://www.npmjs.com/package/lodash.get) (Access deeply nested values)

#### Development Tools

* [webpack](https://webpack.js.org/) (Asset/Package Bundling)

* [babel](https://babeljs.io/) (Transpiles ES7 to ES5)

* [webpack-hot-middleware](https://github.com/glenjamin/webpack-hot-middleware) (Hot Module Replace)

* [plop](https://github.com/amwmedia/plop) (Code Generator)

* [eslint](http://eslint.org/) (Code Style Linter)

### Getting Started with Development

1. clone this repository

2. run `yarn` (might take a while)

3. run `yarn start`

4. go to [`localhost:3000`](http://localhost:3000)

### To Contribute

Please refer to the [CONTRIBUTING.md](https://github.com/howlowck/train-faces/blob/master/CONTRIBUTING.md)

### TODO

* Async Flow in UI

* Auto Refresh on FaceAPIKey change

* Mobile Friendly

* Fix User Data for Face Creation

* Add User Data for Person Group Creation

* Convert ternary operators to `_.get` for readability

* Build dist on server

* Helpful Error Messages