The Hydra Issue Tracker Demo
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., (*1)
This document contains information on how to download, install, and start
using Hydra with Symfony., (*2)
1) Installing the Hydra Issue Tracker Demo
The recommended way to install the Hydra Issue Tracker demo 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:, (*4)
curl -s http://getcomposer.org/installer | php
Then, use the create-project
command to generate a new Hydra application:, (*5)
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., (*6)
Finally you need to create the database (unless it exists already) using, (*7)
php app/console doctrine:database:create
and generate the tables used by the Hydra demo app, (*8)
php app/console doctrine:schema:create
2) Checking your System Configuration
Before starting coding, make sure that your local system is properly
configured for Symfony., (*9)
Execute the check.php
script from the command line:, (*10)
php app/check.php
Access the config.php
script from a browser:, (*11)
http://localhost/path/to/symfony/app/web/config.php
If you get any warnings or recommendations, fix them before moving on., (*12)
3) Browsing the Demo Application
Congratulations! You're now ready to use the Hydra demo app., (*13)
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., (*14)
You can also use a web-based configurator by clicking on the "Configure your
Symfony Application online" link of the config.php
page., (*15)
To see Hydra in in action, access the following page:, (*16)
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., (*17)
4) 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., (*18)
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][6]., (*19)
A default bundle, MLDemoBundle
, shows you Symfony2 and Hydra in action.
After playing with it, you can remove it by following these steps:, (*20)
-
delete the src/MLDemoBundle
directory;, (*21)
-
remove the routing entries referencing DemoBundle in
app/config/routing.yml
;, (*22)
-
remove the MLDemoBundle from the registered bundles in
app/AppKernel.php
;, (*23)
-
remove the web/bundles/mldemo
directory;, (*24)
-
remove the security.providers
and security.firewalls.main
entries
in the security.yml
file or tweak the security configuration to fit
your needs., (*25)