ml/hydra-demo-app

The Hydra issue tracker demo

dev-master 2013-11-21 17:21 UTC

Requires

• php: >=5.3.3
• doctrine/doctrine-bundle: 1.2.*
• doctrine/orm: >=2.2.3,<2.4-dev
• incenteev/composer-parameter-handler: ~2.0
• ml/hydra-bundle: @dev
• ml/json-ld: @dev
• sensio/distribution-bundle: 2.3.*
• sensio/framework-extra-bundle: 2.3.*
• sensio/generator-bundle: 2.3.*
• symfony/assetic-bundle: 2.3.*
• symfony/monolog-bundle: 2.3.*
• symfony/swiftmailer-bundle: 2.3.*
• symfony/symfony: 2.3.*
• twig/extensions: 1.0.*

MIT

• Markus Lanthaler

• symfony
• rest
• Symfony2
• JSON-LD
• hypermedia
• jsonld
• Hydra
• Web API

README

Welcome to the Hydra Issue Tracker demo - a fully-functional Symfony2 application leveraging Hydra that you can use as the skeleton for your new applications.

This document contains information on how to download, install, and start using Hydra with Symfony.

1. Installing the Hydra Issue Tracker Demo

The recommended way to install the Hydra Issue Tracker demo is to use Composer.

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 the create-project command to generate a new Hydra application:

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

Composer will install Symfony, the HydraBundle, and all the dependencies under the path/to/install directory.

Finally you need to create the database (unless it exists already) using

php app/console doctrine:database:create

and generate the tables used by the Hydra demo app

php app/console doctrine:schema:create

1. Checking your System Configuration

Before starting coding, make sure that your local system is properly configured for Symfony.

Execute the check.php script from the command line:

php app/check.php

Access the config.php script from a browser:

http://localhost/path/to/symfony/app/web/config.php

If you get any warnings or recommendations, fix them before moving on.

1. Browsing the Demo Application

Congratulations! You're now ready to use the Hydra demo app.

From the config.php page, click the "Bypass configuration and go to the Welcome page" link to load up the homepage providing more information about the demo app.

You can also use a web-based configurator by clicking on the "Configure your Symfony Application online" link of the config.php page.

To see Hydra in in action, access the following page:

http://localhost/path/to/symfony/app/web/app_dev.php/

Please note that it will return JSON-LD so you might wanna access it using cURL or the Hydra Console.

1. Getting Started

This distribution is meant to be the starting point for your Hydra-powered Web APIs, but it also contains some sample code that you can learn from and play with.

If you are not familiar with Symfony yet, you may wanna get up to speed with the Quick Tour that will take you through all the basic features of Symfony2. Once you're feeling good, you can move onto reading the official Symfony2 book.

A default bundle, MLDemoBundle, shows you Symfony2 and Hydra in action. After playing with it, you can remove it by following these steps:

• delete the src/MLDemoBundle directory;

• remove the routing entries referencing DemoBundle in app/config/routing.yml;

• remove the MLDemoBundle from the registered bundles in app/AppKernel.php;

• remove the web/bundles/mldemo directory;

• remove the security.providers and security.firewalls.main entries in the security.yml file or tweak the security configuration to fit your needs.