Embedded UI for any service that implements the Rancher API spec
Go to file
Vincent Fiduccia 10faf0069c Remove byte order mark in file 2013-08-15 15:04:21 -07:00
bin move binaries, fix editing non-null value to null 2013-06-12 09:26:57 -07:00
public Remove byte order mark in file 2013-08-15 15:04:21 -07:00
.gitignore ignore vim swap files 2013-01-29 14:14:41 -07:00
README.md Add link to spec for integrating with API 2013-03-18 11:48:39 -07:00
assets.json Bootstrap styling, more Explorer, bug fixes 2013-03-29 17:21:10 -07:00
package.json Remove byte order mark in file 2013-08-15 15:04:21 -07:00

README.md

gdapi-ui

An in-browser client for Go Daddy® REST API.

Integrating with your API

See HTML UI in the API specification.

Usage

Compiling the stand-alone CSS and JavaScript files

This will write files to ./compiled/{version}/, suitable for publishing to a CDN.

  ./compile

Running as a standalone server

This will start a server on the given port number (default: 3000) that serves up the assets directly. This mode is mostly suitable for development of this library itself.

  ./serve [port]

Running as part of another Node.js Connect/Express service

This will add a route into your Connect/Express service to respond with the appropriate asset. This mode is suitable for integrating with an existing project that already has a server running.

var express = require('express');
var app = express();

// Your existing routes
app.get('/', function(req, res){
  res.send('Hello World');
});

var assets = require('gd-assets');
var groups = assets.groups.load(__dirname+'/assets.json');
assets.middleware(app, groups)

app.listen(3000);