Permalink
Browse files

Add composer.json to install dependencies and update README

  • Loading branch information...
lanthaler committed Jun 7, 2013
1 parent 7a84e1f commit 73c32cdfb75c58995bdc33d346737fa9391cd167
Showing with 60 additions and 10 deletions.
  1. +3 −0 .gitignore
  2. +36 −9 README.md
  3. +20 −0 composer.json
  4. +1 −1 proxy.php
@@ -0,0 +1,3 @@
/vendor
/composer.lock
/composer.phar
@@ -1,18 +1,45 @@
HydraConsole
==============
============

Hydra is a lightweight vocabulary to create hypermedia-driven Web APIs. By
specifying a number of concepts commonly used in Web APIs it renders the
creation of generic API clients possible.
[Hydra][1] is a lightweight vocabulary to create hypermedia-driven Web APIs.
By specifying a number of commonly used concepts it renders the creation of
generic API clients possible. The HydraConsole is such a generic API client
in the form of a single-page web application.

HydraConsole is an implementation of such a generic API client in the form
of a single-page application.

***This is highly experimental stuff that isn't ready for production use.***
Installation
------------

At the moment, the HydraConsole uses a [JSON-LD Processor][2] and a proxy
written in PHP to access and process responses of Web APIs. Thus, the
simplest way to install the HydraConsole is to use [Composer][3].

If you don't have Composer yet, download it following the instructions on
http://getcomposer.org/ or just run the following command:

curl -s http://getcomposer.org/installer | php

Then, use Composer's `create-project` command to download the HydraConsole
and install all it's dependencies:

php composer.phar create-project -s dev ml/hydra-console path/to/install

That's all. Just fire up your browser and point it to

http://localhost/path/to/install/


Collaboration
------------

To participate in the development please file bugs and issues in the
issue tracker or submit pull requests. If there's enough interest I'll
create a dedicated mailing list in the future.

You can find more information about Hydra and a demo on my homepage:
http://www.markus-lanthaler.com/hydra/
You can find more information about Hydra and a demo installation of the
HydraConsole on my homepage: http://www.markus-lanthaler.com/hydra/


[1]: http://www.markus-lanthaler.com/hydra/
[2]: http://m.lanthi.com/json-ld
[3]: http://getcomposer.org/
@@ -0,0 +1,20 @@
{
"name": "ml/hydra-console",
"type": "project",
"description": "HydraConsole is a generic API console for Hydra-powered Web APIs",
"keywords": [ "JSON-LD", "jsonld", "Hydra", "Web API", "Symfony", "Symfony2", "hypermedia", "REST" ],
"homepage": "http://www.markus-lanthaler.com/hydra/",
"license": "MIT",
"authors": [
{
"name": "Markus Lanthaler",
"email": "mail@markus-lanthaler.com",
"homepage": "http://www.markus-lanthaler.com",
"role": "Developer"
}
],
"minimum-stability": "dev",
"require": {
"ml/json-ld": "dev-expansion-debug"
}
}
@@ -1,7 +1,7 @@
<?php
require('proxylib.php');
require('../../vendor/autoload.php');
require('vendor/autoload.php');
ini_set('html_errors', 0);

0 comments on commit 73c32cd

Please sign in to comment.