GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → futurice → op-hackathon-templates

futurice / op-hackathon-templates

Licence: other
App templates demonstrating OP's API usage with Cycle.js

Programming Languages

javascript
184084 projects - #8 most used programming language
objective c
16641 projects - #2 most used programming language
java
68154 projects - #9 most used programming language
HTML
75241 projects

OP Hackathon code templates

To get started building, we provide some template source code which you can use as a starting point. This repository contains web and mobile clients that access OP's APIs. There are three applications:

  • A Web Single-Page Application (SPA) built with Cycle.js
  • An Android app built with React Native and Cycle.js
  • An iOS app built with React Native and Cycle.js

The apps are simple, because the codebase is meant to be a template on which you can easily hack and get started experimenting with OP's APIs.

Getting started

Download the repository:

git clone [email protected]:futurice/op-hackathon-templates.git

Make sure you have npm and Node.js v4 installed. If you don't have them yet installed, we recommend using nvm.

Install necessary packages:

npm install

Initial setup

Once you register to OP's Developer Portal, you can add a new "app" in order to get authentication keys to use the APIs.

Create the file src/apikey.js and insert your "Consumer Key" found from the Developer Portal". Follow the template file given at src/apikey.js.example.

To run the Web SPA

Execute

npm run web

This will create a single JavaScript bundle file and open your default browser with the page shown. You might need to refresh that page.

To run the Android app

You need to have the latest JDK and the Android SDK installed. For Mac, download it with brew install android-sdk, and for other operating systems, read this. Read these instructions if your setup isn't working.

  • Open an Android emulator
  • Execute npm run android
  • To reload the JavaScript, you need to open the app menu (using F2 in the stock emulator)
  • You might need to run the app in debug mode, in case you see errors

To run the iOS app

You need a Mac OS X computer and Xcode 6.3 or higher. It can be installed from the App Store. You might need to install also watchman, for instance with brew install watchman.

  • Open ios/OPMobileTemplate.xcodeproj in Xcode and press "run" (arrow button).
  • Press ⌘-R in your iOS simulator to reload the app after changing code.
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].