Skip to content

Home

Jump to bottom
Luis Mendez edited this page Jul 14, 2021 · 5 revisions

Welcome to the Symprowire wiki!

This is the main Documentation for the Symprowire Framework. To get started with Symprowire just follow the Step by Step Documentation.

Symprowire is targeted at Developers with a deep understanding of ProcessWire 3.x and some knowledge of the MVC Pattern in Web-Software.

Even Symprowire is based on Symfony you do not need to have a deep understanding of it yet, as Symprowire tries to abstract most of configuration and glue away. To make usage and the combination of both worlds a breeze.

To install Symprowire you will need a freshly installed ProcessWire with a version of atleast 3.0.181 and the blank-profile.

Symprowire ships with the Symprowire.module to integrate easy and nicely in ProcessWire. The Module acts as a glue or bridge component and will take over the whole rendering Process from ProcessWire.

Installation

Before installing Symprowire, please make sure you have a fresh ProcessWire 3.0.181 Installation up and running with the blank-profile.

  • Copy the Symprowire Module Directory into site/modules
  • open a console in site/modules/symprowire
  • and let composer install the Framwork Dependencies.

If you want to use symfony/webpack-encore

  • yarn install
  • yarn build

and you are good to go.

Now go back to your ProcessWire Admin and visit the Modules Section.

Module Installation

You can now install Symprowire like any other Module. Symprowire will create a new site/templates/twig directory upon installation. This would be the home of all your Twig Template files.

In addition, Symprowire will create a new 'frontcontroller' Template, assign it to the Homepage and add a corresponding file inside your templates directory.

The Installer Class

To make your Symprowire Application easily portable, Symprowire ships with a Installer Class which provides the run() function.

You have full access to ProcessWire inside the Installer via $this-wire which open up the possibility to create Pages, Templates etc. on installation without poluting the Framework Module File.

You can see the Installer as some kind of Base-State-Creation to quickly Install a Full Application into a fresh ProcessWire Installation. You can learn about the Usage in the Blog-Project Walk-trough.

There is no need to delete the Installer as you can use the Installer later on if you happen to need your Application run on different Servers or machines.

Clone this wiki locally