Community Circles

Mobile client for Community Circles

Setup

Run npm install and bower install in project root folder.

.keystore file

keytool -genkey -v -keystore b-part.keystore -alias bpart_keystore_alias -keyalg RSA -keysize 2048 -validity 10000

Upload this file, specify a password and use bpart_keystore_alias as alias name.

Afterwards you can press Build Scanner and upload to your phone.

Private Settings

Provide a private.coffee file in app/community-circles/ with following content:

@key =
  FOURSQUARE_CLIENT_ID: "<client_id>#"
  FOURSQAURE_CLIENT_SECTRET: "<client_secret>"

@config =
  SUPPORT_EMAIL: "<contact_email>"

The client needs severeal API keys, e.g. from Foursquare.

To create a Foursquare app go to https://foursquare.com/developers/register.

Exclude components from SASS compiler

Steroids will compile all SASS files through a grunt task, however in the components folder it's not unusual, that packages contain SASS files causing compilation errors. Therefore, you will need to exlude them by adding following code in /node_modules/grunt-steroids/tasks/steroids-compile-sass.coffee (neccessary, since node_module is in .gitignore): in the section of grunt.extendConfig add the '!components/**' to the second src field. It should look something like this:

grunt.extendConfig
  sass:
    dist:
      files: [
        {
          expand: true
          cwd: 'app/'
          src: ['**/*.scss', '**/*.sass']
          dest: 'dist/'
          ext: '.css'
        }
        {
          expand: true
          cwd: 'www/'
          src: ['**/*.scss', '**/*.sass', '!components/**', '!**/_*.scss', '!**/_*.sass']
          dest: 'dist/'
          ext: '.css'
        }
      ]

Debug

Run steroids connect, on OSX you can run the simulator then by typing simulator. More information on the Steroids documentation.

You can also run the project in your browser by typing steroids connect --serve (server is available at http://localhost:4000/).

For other platforms refere to http://guides.appgyver.com/steroids/guides/debugging/best-practices/.

Deploy

steroids deploy

The app uses following custom PhoneGap plugins (currently not in use):

Therefore it is neccessary to build a custom Scanner app, in order to run the app. Register an account at AppGyver, afterwards you can link your local Steroids environment with your account by typing steroids login. For Android goto your applicatoins and specify following configuration:

Android Build Settings (currently not in use)

[
  {"source": "https://github.com/radshag/PhoneGap-Geofencing.git"},
  {"source": "https://github.com/katzer/cordova-plugin-local-notifications"},
  {"source": "https://github.com/AppGyver/BackgroundTracking"}
]

Note that you also have to specify other attributes, see Android Build Configuration

Editor

Indent using spaces, space width: 2

Localization

All the translation template is located in po/template.pot, which can be modified with e.g. Poedit.