Spin up infrastructure and services in a cloud, virtualized, or baremetal environment.
This application is both a gem and a Sinatra application.
Harp requires Ruby 1.9.2 or 1.9.3. We recommend installing RVM to keep a separate Ruby from your system Ruby.
Some client-side packages are required. We use Node.JS and Jam (jamjs.org) for client packages.
Install Node.JS in the usual manner for your platform.
With Node.JS installed, pull down the client packages as follows:
npm install -g jamjs
jam install
npm install -g bower
npm install http-browserify
bower install
For local testing, you can invoke the app with Shotgun.
bundle install
shotgun config.ru
Browse to the local server at http://localhost:9393.
The API documentation is generated form source, and includes the ability to invoke the API from the documentation. Type the following to generate documentation:
# If you haven't already, bundle
bundle install
./script/document
After generating the documentation, the live API documents are available.
http://localhost:9393/docs/api.html
Ruby RDoc is available as well:
http://localhost:9393/docs/index.html
Add this line to your application's Gemfile:
gem 'harp-runtime'
And then execute:
$ bundle
Or install it yourself as:
$ gem install harp-runtime
Some sample harp scripts are included in the /sample directory. Check out the samples for intended usage.
The Harp runtime uses DataMapper for persistence; the default development engine is SQLite.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
You can follow along as we build out and improve this project with our collaborative viewer.
[