4. Development

To contribute to the development of xTools, you may fork us on GitHub. A few things to be aware of first:

  1. xTools is based on Symfony 3.0. We use Twig as our template engine. Symfony is a full MVC system.
  1. The controllers are located at src/AppBundle/controller. They are sorted by tool
  2. The twig templates are located at app/resources/views. They are sorted by tool.
  1. We use the @Route syntax to configure routes.
  2. Every tool requires a twig directory and one controller. Also, core parts of xTools require the tool to be registered within app/config/tools.yml.

4.1. Style Guideline

  • We use 4 spaces to indent code.
  • Opening and closing curly braces must be on their own lines.
  • Variable names are camelCase. Constants are ALL_CAPS_AND_UNDERSCORES. Function names are camelCase.
  • Functions and routes must begin with the tool name.

4.2. Running Development server

Follow these steps

  1. Download the repository.
  2. Run composer install
  3. Issue php bin/console server:run.
  4. Visit http://localhost:8000 in your web browser.

The development server does not cache data. Any changes you make are visible after refreshing the page.

4.3. Additional Help

Please contact User:Matthewrbowker or User:MusikAnimal if you need help. Or, you are welcome to visit us on IRC (Direct link - Requires an IRC client).