glavweb/symfony-rest

The "Symfony Edition" distribution for REST API

v1.1.1 2016-10-19 02:16 UTC

Requires

• php: >=5.5.9
• braincrafted/bootstrap-bundle: ~2.2
• doctrine/doctrine-bundle: ^1.6
• doctrine/doctrine-cache-bundle: ^1.2
• doctrine/doctrine-fixtures-bundle: ~2.3
• doctrine/doctrine-migrations-bundle: ~1.1
• doctrine/migrations: ~1.4
• doctrine/orm: ^2.5
• fresh/doctrine-enum-bundle: ~4.5
• friendsofsymfony/http-cache-bundle: ^1.0
• friendsofsymfony/rest-bundle: ~1.7
• friendsofsymfony/user-bundle: dev-master
• glavweb/action-bundle: ~1.0
• glavweb/core-bundle: ~1.1
• glavweb/datagrid-bundle: ~1.1
• glavweb/rest-bundle: ~1.1
• glavweb/security-bundle: ~0.1
• hautelook/alice-bundle: ~1.2
• incenteev/composer-parameter-handler: ^2.0
• liip/functional-test-bundle: ~1.6
• liip/imagine-bundle: ~1.5
• nelmio/alice: ~2.1
• nelmio/api-doc-bundle: ~2.12
• nelmio/cors-bundle: ~1.4
• phpunit/phpunit: ~4.2
• sensio/distribution-bundle: ^5.0
• sensio/framework-extra-bundle: ^3.0.2
• sonata-project/admin-bundle: ^3.0
• sonata-project/datagrid-bundle: dev-master
• sonata-project/doctrine-orm-admin-bundle: ^3.0
• sonata-project/intl-bundle: ~2.2
• symfony/monolog-bundle: ^2.8
• symfony/swiftmailer-bundle: ^2.3
• symfony/symfony: 3.1.*
• vich/uploader-bundle: ~1.0

Requires (Dev)

• sensio/generator-bundle: ^3.0
• symfony/phpunit-bridge: ^3.0

MIT

README

Welcome to the Symfony REST Edition - a fully-functional Symfony application that you can use as the skeleton for your new applications.

For details on how to download and get started with Symfony, see the Installation chapter of the Symfony Documentation.

1. Installing the REST Edition

When it comes to installing the Symfony REST Edition, you have the following options.

Get the application using composer

As Symfony uses Composer to manage its dependencies, the recommended way to create a new project is to use it.

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 Symfony application:

php composer.phar create-project glavweb/symfony-rest path/to/application

Composer will install Symfony and all its dependencies under the path/to/application directory.

Execute migrations:

php bin/console d:m:m -n

Execute fixtures:

php bin/console h:d:f:l -n

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/application/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 Symfony.

From the config.php page, click the "Bypass configuration and go to the Welcome page" link to load up your first Symfony page.

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 a admin dashboard, access the following page:

http://localhost/path/to/application/admin

User access:

login: admin
password: weloveglavweb

To see a API documentation, access the following page:

http://localhost/path/to/application/api/doc

Where you can test your API.

What's inside?

The Symfony Standard Edition is configured with the following defaults:

• An AppBundle you can use to start coding;

• Twig as the only configured template engine;

• Doctrine ORM/DBAL;

• Swiftmailer;

• Annotations enabled for everything.

It comes pre-configured with the following bundles:

• FrameworkBundle - The core Symfony framework bundle

• SensioFrameworkExtraBundle - Adds several enhancements, including template and routing annotation capability

• DoctrineBundle - Adds support for the Doctrine ORM

• TwigBundle - Adds support for the Twig templating engine

• SecurityBundle - Adds security by integrating Symfony's security component

• SwiftmailerBundle - Adds support for Swiftmailer, a library for sending emails

• MonologBundle - Adds support for Monolog, a logging library

• WebProfilerBundle (in dev/test env) - Adds profiling functionality and the web debug toolbar

• SensioDistributionBundle (in dev/test env) - Adds functionality for configuring and working with Symfony distributions

• SensioGeneratorBundle (in dev/test env) - Adds code generation capabilities

• DebugBundle (in dev/test env) - Adds Debug and VarDumper component integration

• FOSRestBundle - Adds rest functionality

• NelmioApiDocBundle - Add API documentation features

All libraries and bundles included in the Symfony Standard Edition are released under the MIT or BSD license.

Enjoy!