https://github.com/thurloat/contextualsdk

SDK for developing Google Contextual Gadgets right in the browser
https://github.com/thurloat/contextualsdk

Last synced: 9 days ago
JSON representation

SDK for developing Google Contextual Gadgets right in the browser

• Host: GitHub
• URL: https://github.com/thurloat/contextualsdk
• Owner: thurloat
• License: other
• Created: 2012-01-07T00:52:22.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2017-09-30T04:14:23.000Z (about 7 years ago)
• Last Synced: 2024-04-13T22:13:37.913Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 242 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Contextual SDK

==============

SDK for developing google / xobni contextual gadgets right in the browser with the tools you're used to using.

No messy iframe junk to get in your way.

Features

--------

Command Line Utility

....................

installs as a package and can be run in any area.

generates a project scaffolding so you put your tests in the right spot, a default application.xml and gadget.xml file

SDK Dashboard

.............

server runs at localhost:8000/

main view shows a list of actions. run unit tests, configure test environment, and launch test environment

Configuration screen allows you to set the email body, any content matches from google, and additional url args that

might be passed into the iFrame Renderer.

Unit Testing

............

mocha http://visionmedia.github.com/mocha/

iFrame Renderer

...............

at http://localhost:8000/ifr? it renders the gadget

makeRequest Proxy

.................

there will be a request proxy to handle gadgets.io.makeRequest proxying at http://localhost:8000/proxy

setPrefs backend

................

localStorage or filesystem.

packaging and deployment

........................

deploys directly to s3 using knox. http://thechangelog.com/post/2128784522/knox-s3-lib

code compiles with uglify.js

Development

-----------

If you want to hack on contextualsdk, you can install all of its dependencies

like this:

::

    $ npm install

And then add the command to your ``PATH`` with npm's handy

::

    $ npm link

Compilation

...........

You can use the nifty ``cake`` command to compile all coffeescript files in

``src/`` to javascript in ``lib/``.

:: 

    $ cake build

If you are working on the express server you might find it easier to run it

directly like this:

::

    $ coffee src/sdk.coffee

instead of recompiling all the time.