Skip to content

Commit

Permalink
Add composer.json to install dependencies and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lanthaler committed Jun 7, 2013
1 parent 7a84e1f commit 73c32cd
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .gitignore
@@ -0,0 +1,3 @@
/vendor
/composer.lock
/composer.phar
45 changes: 36 additions & 9 deletions README.md
@@ -1,18 +1,45 @@
HydraConsole HydraConsole
============== ============


Hydra is a lightweight vocabulary to create hypermedia-driven Web APIs. By [Hydra][1] is a lightweight vocabulary to create hypermedia-driven Web APIs.
specifying a number of concepts commonly used in Web APIs it renders the By specifying a number of commonly used concepts it renders the creation of
creation of generic API clients possible. 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 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 issue tracker or submit pull requests. If there's enough interest I'll
create a dedicated mailing list in the future. create a dedicated mailing list in the future.


You can find more information about Hydra and a demo on my homepage: You can find more information about Hydra and a demo installation of the
http://www.markus-lanthaler.com/hydra/ 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/
20 changes: 20 additions & 0 deletions composer.json
@@ -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"
}
}
2 changes: 1 addition & 1 deletion proxy.php
@@ -1,7 +1,7 @@
<?php <?php


require('proxylib.php'); require('proxylib.php');
require('../../vendor/autoload.php'); require('vendor/autoload.php');


ini_set('html_errors', 0); ini_set('html_errors', 0);


Expand Down

0 comments on commit 73c32cd

Please sign in to comment.