Skip to content

Implements a headless Rory application for interacting with a Bumbleworks instance.

License

Notifications You must be signed in to change notification settings

bumbleworks/bumbleworks-api

Repository files navigation

Bumbleworks::Api

A rack-based web API (using Rory) for your Bumbleworks instance.

Installation

Add this line to your application's Gemfile:

gem 'bumbleworks-api'

Usage

There are quite a few ways to use this - the most common, if you're using Bumbleworks in a Rails app, would probably be to mount Bumbleworks::Api::Application at some path in your Rails routing - see the Rails routing guide for more info.

Or you can run it standalone using a Rack server - basically, Bumbleworks just needs to be configured, and then you can run Bumbleworks::Api::Application.

Note that you can also use bumbleworks-gui, which wraps this API in a simple GUI.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

Implements a headless Rory application for interacting with a Bumbleworks instance.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages