https://github.com/niftynei/hsfacesandroid

This is a port of the HSFaces app to Android.
https://github.com/niftynei/hsfacesandroid

Last synced: 3 months ago
JSON representation

This is a port of the HSFaces app to Android.

• Host: GitHub
• URL: https://github.com/niftynei/hsfacesandroid
• Owner: niftynei
• Created: 2013-09-16T02:16:59.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-07-03T21:29:10.000Z (over 9 years ago)
• Last Synced: 2023-03-24T08:46:14.534Z (almost 2 years ago)
• Language: Java
• Homepage: https://github.com/adamfraser/HSFaces
• Size: 1.43 MB
• Stars: 5
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# HSFaces, the Android Port

This is a port of [HSFaces](https://github.com/adamfraser/HSFaces) project.  It's a memory game and Hacker School directory.

for former and current students.

## Game Play

Users are shown a randomly selected subset of all Hacker Schoolers.  After a designated number of guesses, the game ends.

## Browsing for a Hacker Schooler

This app also provides a directory of Hacker Schoolers.  It's sorted (at the moment) by batch, then name.  If they've provided it online,

this allows you to visit their github, twitter, or email from within the app.  You can drill down to see more details for each 

Hacker Schooler.

### Bug reports

Thanks for filing a bug.  Any issues that you have should be filed in the Issues section of the Github project.

# Onward and upward

## Proposed future work

- [ ] Keep list of common nicknames

- [ ] Integration with phone contacts

# Getting the app up and running

## How to build

1. Install [Android Studio](https://developer.android.com/sdk/installing/studio.html). Currently builds and runs on Android Studio version 0.8.8.

2. In Android Studio use the SDK Manager (button in toolbar or in menu under Tools -> Android) to install Android Support Repository, Google Repository (in Extras) and sources for API 18 (or one supported by your device). You'll also need the build tools v20.

3. Open (not import) the project in Android Studio

4. Copy over local.properties.sample to local.properties, edit if you installed Android Studio in a different location

5. "Sync Project with Gradle Files" (button in toolbar or in menu under Tools -> Android)

6. Run project (button in toolbar or in menu under Run)

__ See note about API keys before running __

## Using API Keys

The app uses Gradle properties to keep Hacker School API secrets a secret.  You'll need to supply your own API key in order for the app to function properly. (All Hacker Schoolers can get one from the Hacker School login portal).

Once you've obtained a super secret Key and Client ID, you'll need to replace the ones that are in this build.

To add your Secret key to the project, create a `gradle.properties` file in the project's root directory and add the following:

```

    api_secret=

    client_id=

```

This keys will automatically be picked up and injected into the app as a Build config as part of the build process.  (Gradle is magic).

## A Note on IDEs

This project works well with Android Studio.  I haven't tried using it with Eclipse.

## Contributions

If there's a feature that you'd like to add, please open up an Issue on this Github project before you begin so that I know what you're planning to work on.

Bug fixes always welcome.

# Due Diligence

This app owes much to:

- Apache's [Oltu](https://oltu.apache.org/) project, a Java OAuth library

- Square's [Retrofit](http://square.github.io/retrofit/), a network / object marshalling library