dimug/api

Basic, silex based, implementation of the API for diMuG (digital Museums Guide)

dev-master 2013-11-10 03:42 UTC

Requires

• php: >=5.3.3
• monolog/monolog: 1.6.*
• silex/silex: 1.1.*
• symfony/config: 2.3.*
• symfony/console: 2.3.*
• symfony/security: 2.3.*
• symfony/translation: 2.3.*
• symfony/yaml: 2.3.*

Requires (Dev)

• mikey179/vfsstream: 1.2.*
• phpunit/phpunit: 3.7.*
• satooshi/php-coveralls: 0.6.*
• symfony/browser-kit: 2.3.*

GPL-3.0

• Benjamin Geißler

• project

README

This is an sample implementation of an API to provide a data source for diMuG - the digital Museums Guide. It's based on silex.

Installation

1. Install composer or just run the following command:

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

1. Add following to your composer.json and run composer install.

    "require" : {
        "dimug/api": "dev-master"
    }

1. Run the additional install script via the console by running the following command:

    vendor/bin/dimug api:install

or if you prefer Deutsch:

    vendor/bin/dimug api:install de

How to connect your data source

1. Create a class which implements the diMuG\APIv1\Interfaces\FinderInterface.

2. Create a class which implements the diMuG\APIv1\Interfaces\GlossaryInterface.

3. Use the PHPUnit test skeleton files in the dir tests to test your classes.

4. Edit the configuration files config/configuration.yml and config/security.yml so that they represent your data. Use the following console command to test your configuration files:

    vendor/bin/dimug api:validate

or if you prefer Deutsch:

    vendor/bin/dimug api:validate de

1. If everything is working, upload your files to your webserver and point your web-root to web. For further configuration details look into the silex documenation.