Skip to content

Commit

Permalink
Updated readme. Added method for NO Dev Server
Browse files Browse the repository at this point in the history
  • Loading branch information
vigzmv committed Jun 20, 2017
1 parent 056c95e commit 03d361e
Showing 1 changed file with 42 additions and 13 deletions.
55 changes: 42 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,79 @@
# What the Thing ?
Point camera at things to learn how to say them in a different language.
Native Android App built with [React Native](https://github.com/facebook/react-native).

[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=102)](https://github.com/vigzmv/Django-Users-boilerplate)   
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/vigzmv/Django-Users-boilerplate)   
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/vigzmv/Django-Users-boilerplate)

Point camera at things to learn how to say them in a different language.

Native Android App built with [React Native](https://github.com/facebook/react-native).

Made it as a part of my learning process of [React](https://github.com/facebook/react-native) and [React Native](https://github.com/facebook/react-native).

Inspired by [Thing Translator](https://github.com/dmotz/thing-translator) by [dmotz](https://github.com/dmotz).

![ezgif-2-c2d47b51b0](https://cloud.githubusercontent.com/assets/14950089/24720723/b2305c4e-1a5b-11e7-8717-672866128ef0.gif)
    
![58e4ef22e1d7d646107794](https://cloud.githubusercontent.com/assets/14950089/24707372/ec7b4538-1a30-11e7-944d-98addd4ff146.gif)
![58e4ef22e1d7d646107794](https://cloud.githubusercontent.com/assets/14950089/24707372/ec7b4538-1a30-11e7-944d-98addd4ff146.gif)

## How it works ?

Concepts present in captured image are extracted and translated to the given language.

It uses

- [Clarifai's](https://clarifai.com/) concept recognition from images
- [Yandex's](https://tech.yandex.com/translate/) language translation.

## Try it ?

Have a look at the [React-native Docs](https://facebook.github.io/react-native/docs/getting-started.html) to set up a development environment for React-native and Android.

```sh
# Install react-native
sudo npm install -g react-native-cli
$ sudo npm install -g react-native-cli

# Clone repository
git clone https://github.com/vigzmv/what_the_thing.git
cd what_the_thing
$ git clone https://github.com/vigzmv/what_the_thing.git
$ cd what_the_thing

```

Get your free API keys from [Clarifai](https://clarifai.com/) and [Yandex](https://tech.yandex.com/translate/). It is easy and free.
Get your free API keys from [Clarifai](https://clarifai.com/) and [Yandex](https://tech.yandex.com/translate/). It is easy and free.

Place them in `./apiKeys.json`.

```sh
# Install required packages
yarn install || npm install
$ yarn install || npm install

# Install the project on device
# This will install the application on a running Android emulator or a connect Android device
react-native run-android
# Install the application on a running Android emulator or a connected Android device
$ react-native run-android

# Run the server/bundler
react-native start
$ react-native start

# Done !
```

<hr/>

For a build that doesn't reqire the development server:

```sh

# Bundle debug build
$ react-native bundle --dev false --platform android --entry-file index.android.js --bundle-output ./android/app/build/intermediates/assets/debug/index.android.bundle --assets-dest ./android/app/build/intermediates/res/merged/debug

# Create debug build
$ cd android && ./gradlew assembleDebug

# Generated apk will be located at android/app/build/outputs/apk. Install it with
$ adb install app/build/outputs/apk/app-debug.apk

```


_I would be releasing a signed apk package soon which could be installed directly to device for usage._

## Contribute ?
Expand All @@ -53,6 +82,6 @@ _I would be releasing a signed apk package soon which could be installed directl
- Commit your changes
- Submit a pull request


## Licence

[MIT Licence](https://github.com/vigzmv/what_the_thing/blob/master/LICENSE) © [Vignesh M](https://vigneshm.com)

0 comments on commit 03d361e

Please sign in to comment.