README.rst 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. Silex Skeleton
  2. ==============
  3. Welcome to the Silex Skeleton - a fully-functional Silex application that you
  4. can use as the skeleton for your new applications.
  5. This document contains information on how to start using the Silex Skeleton.
  6. Creating a Silex Application
  7. ----------------------------
  8. Silex uses `Composer`_ to ease the creation of a new project:
  9. .. code-block:: console
  10. $ composer create-project fabpot/silex-skeleton path/to/install "~2.0"
  11. Composer will create a new Silex project under the `path/to/install` directory.
  12. Browsing the Demo Application
  13. -----------------------------
  14. Congratulations! You're now ready to use Silex.
  15. To see a real-live Silex page in action, start the PHP built-in web server with
  16. command:
  17. .. code-block:: console
  18. $ cd path/to/install
  19. $ COMPOSER_PROCESS_TIMEOUT=0 composer run
  20. Then, browse to http://localhost:8888/index_dev.php/
  21. Getting started with Silex
  22. --------------------------
  23. This distribution is meant to be the starting point for your Silex applications.
  24. A great way to start learning Silex is via the `Documentation`_, which will
  25. take you through all the features of Silex.
  26. What's inside?
  27. ---------------
  28. The Silex Skeleton is configured with the following service providers:
  29. * `ValidatorServiceProvider`_ - Provides a service for validating data. It is
  30. most useful when used with the FormServiceProvider, but can also be used
  31. standalone.
  32. * `ServiceControllerServiceProvider`_ - As your Silex application grows, you
  33. may wish to begin organizing your controllers in a more formal fashion.
  34. Silex can use controller classes out of the box, but with a bit of work,
  35. your controllers can be created as services, giving you the full power of
  36. dependency injection and lazy loading.
  37. * `TwigServiceProvider`_ - Provides integration with the Twig template engine.
  38. * `WebProfilerServiceProvider`_ - Enable the Symfony web debug toolbar and
  39. the Symfony profiler in your Silex application when developing.
  40. * `MonologServiceProvider`_ - Enable logging in the development environment.
  41. Read the `Providers`_ documentation for more details about Silex Service
  42. Providers.
  43. Enjoy!
  44. .. _Composer: http://getcomposer.org/
  45. .. _Documentation: http://silex.sensiolabs.org/documentation
  46. .. _ValidatorServiceProvider: http://silex.sensiolabs.org/doc/master/providers/validator.html
  47. .. _ServiceControllerServiceProvider: http://silex.sensiolabs.org/doc/master/providers/service_controller.html
  48. .. _TwigServiceProvider: http://silex.sensiolabs.org/doc/master/providers/twig.html
  49. .. _WebProfilerServiceProvider: http://github.com/silexphp/Silex-WebProfiler
  50. .. _MonologServiceProvider: http://silex.sensiolabs.org/doc/master/providers/monolog.html
  51. .. _Providers: http://silex.sensiolabs.org/doc/providers.html