QCharts is a powerful visual aid and very handy tool to use when querying a lot of data from a database to its analysis and team collaboration.

• Require QCharts via composer.
  • Alternate installation would be to add directly QCharts to a target project.

composer require arnulfosolis/qcharts @dev

• Installing QCharts using composer is pretty simple

composer install

• Add the Bundles to the target's AppKernel.

  • QCharts\CoreBundle\CoreBundle
  • QCharts\FrontendBundle\FrontendBundle
  • QCharts\ApiBundle\ApiBundle

• QCharts needs some configuration in the target project prior to the execution.

  • For a more in-depth configuration please refer to the CONFIG_README.md file located in QChart's directory.

#app/config/config.yml

#QCharts, this will be filled by the defaults
core:
    urls:
    limits:
    paths:
    roles:
    charts:

• Resolve QCharts User interface on orm's definition to your User Class.

  • Refer to the CONFIG_README.md file for further details.
  • resolve_target_entities

• QCharts requires access to your target's database, since QCharts requires to persists inforamtion, so:

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

• Since the project comes included with a web application, QCharts requires assetic to be dumped.
  • You have to register QChart's FrontendBundle in the assetic's bundles configuration.

php app/console assetic:dump

• QCharts comes with three bundles.
  • The CoreBundle comes with all the important services needed to get your data formatted.
  • The ApiBundle that handles QChart's API.
  • And the client application laying in the FrontendBundle.
• QCharts also comes with a full frontend application which comes with a some basic QChart's tool management.
• To start using it, login using the targeted project security measures, and start going through all the list of the Requested Queries other developers have submitted.
• To request a Query to be charted, you can go directly to /query/register.
  • Notice: The user has to hold the mapped QChart's role admin.
    • For more information about setting up the user roles, consult the CONFIG_README.md file in the root directory of QCharts.
• QCharts uses the first column in the table of the results from the requested Query to represent the X-Axis of the graph.
• Have fun!