README

Using IPapp

IPapp is an Instant Places application generator. It will create the basic application structure, contact points and will keep your manifest file updated in the process.

It is a recommended workflow as it will guide you and help you getting started with Instant Places Applications.

Installation

IPapp is written in NodeJS. Just grab a suitable copy for your platform from the official site and install it. The installer should include npm, so you can run:

npm install -g IPapp

And we're done. IPapp is installed. You should now have an ipapp executable available in your system.

Application Initialization

The first thing you need is a project folder. Any folder will do the job. Then, in the folder, run the initialization command:

ipapp init

The generator will then ask you about some details of your application:

name
description
version
your name
your e-mail
and some keywords that properly identify your application.

This information is required to generate the first version of your manifest.json file. This file should be in the root folder and contain the details you previously entered.

Additionally, a basic structure of your application should exist in your directory.

Generating Contact Points

Your application won't do much until you generate some contact points. At the moment, the generator supports the following contact points:

Public display
Mobile Device
Place Web Page

To generate a contact point just run the following command in your project's root folder:

ipapp contactpoint <type>

The type argument can be display, mobile or web. Notice that the manifest file is updated with the corresponding contact point that was generated. This command will check for the manifest file, so it is mandatory to run it in a previously initialized project.

Serving Your Application

For development purposes, IPapp is bundled with a simple static http server. You can use it to quickly test your application, without any deployment process. To use it, you can run:

ipapp server

This will start the http server in port 8888, by default. Optionally you can set a specific port:

ipapp server 12345

Future Work

Application Build:

Minify CSS and javascripts
Compile Coffescript, Sass and Less

Configuration steps generator.

Regular Application Structure:

+-AppName/
  +-display/
  | +-index.html
  | +-style/
  |   +-style.css
  | +-script/
  |   +-lib/
  |     +-specific_lib.js
  |   +-main.js
  +-mobile/
  | +-index.html
  | +-style/
  |   +-style.css
  | +-js/
  |   +-main.js
  +-common/
  | +-js/
  |   +-api.js
  |   +-scheduler.js
  |   +-presentation_units.js
  |   +-other_libraries.js
  | +-css/
  |   +-global.css
  | +-img/
  |   +-logo.png
  |   +-user.png
  +-subscription/
  |   +-index.html
  +-activation/
      +-index.html

Usage no npm install needed!