ingewikkeld/resourceful

Symfony2-based REST API setup

0.1 2014-04-07 08:48 UTC

Requires

• php: >=5.3.3
• doctrine/doctrine-bundle: 1.2.*
• doctrine/doctrine-migrations-bundle: dev-master
• doctrine/orm: 2.3.*@dev
• friendsofsymfony/oauth-server-bundle: dev-master
• friendsofsymfony/rest-bundle: dev-master
• friendsofsymfony/user-bundle: dev-master
• guzzle/guzzle: ~3.1
• jms/di-extra-bundle: 1.4.*
• jms/security-extra-bundle: 1.5.*
• jms/serializer-bundle: dev-master
• keeguon/oauth2-php: >=1.0.0
• lunetics/locale-bundle: 2.2.*
• sensio/distribution-bundle: 2.3.*
• sensio/framework-extra-bundle: 2.3.*
• sensio/generator-bundle: 2.3.*
• stof/doctrine-extensions-bundle: ~1.1@dev
• symfony/assetic-bundle: 2.1.*
• symfony/monolog-bundle: 2.3.*
• symfony/swiftmailer-bundle: 2.3.*
• symfony/symfony: 2.3.*
• twig/extensions: 1.0.*
• zircote/hal: dev-master

Requires (Dev)

• mockery/mockery: 0.8.*

MIT

README

Resourceful is a ready-to-use Symfony2-based 'Rapid API Development' (RAPID) setup to create a REST API with as little effort as possible.

Features

Resourceful comes with the following features out-of-the-box:

• User management.
• oAuth2 authorization and Client management.
• i18n and language selection using the Accept-Language header (defaults to english).
• Support for XML and JSON using the Content-Type and Accepts header.

Installation instructions

1. Clone this repository:

   git clone [e-mail]:Ingewikkeld/Resourceful.git

2. Initialize and boot the Vagrant virtual machine:

   vagrant up

We know that there will be some red "warnings" during the run, but you should be okay.

1. Go into the vagrant machine and switch to the right directory:

   vagrant ssh cd /vagrant

2. Update database with schema

   php app/console doctrine:schema:update --force

Do not forget to add the URL 'local.resourceful.ingewikkeld.net' to your hosts file with IP 192.168.43.43. After the installation has completed you can visit that location to see your REST API.

Please see https://github.com/Ingewikkeld/Resourceful for more information or read the documentation in the docs folder.