Getting Started

Prerequisites

To run and develop ff based websites, you will only need a http webserver that runs php. If you're new to this topic you can use XAMPP to get started quickly.

Installation

create a folder with the project name and put a copy of ff in it.
point your server to this folder and open it in your browser.
on a fresh install, ff will ask you to set an administrator name and password. You should see a blank page and an admin bar on top. You're done.

Anatomy

Before we delve into a real-world example project, let us first have a look at ff's file structure:

Project         // web server's root
|
+-- content     // storage for structure, content and metadata.
|
+-- management  // storage for configuration, logs and cache
|
+-- system      // application logic and assets
|
+-- index.php

The folder of main interest is "system/plugins". It contains all the currently installed plugins that this installation is using. For our example we will create a plugin called "myPlugin".

The structure shows the scaffolding of a plugin folder. The folders listed here (plus some more), are "special" folders in a sense that ff's [pluginLoader] knows where to look for certain components. A part from that, you can organise your plugin-folder, however you whish.

Project
|
+-- content
|
+-- management
|
+-- system
|   |
|   +-- plugins
|       |
|       +-- myPlugin
|           |
|           +-- classes   // php classes go here
|           |
|           +-- css       // stylesheet files (.css, .less) go here
|           |
|           +-- i18n
|           |
|           +-- js        // javascript files (.js) go here
|           |
|           +-- panels    // custom admin panels go here
|           |
|           +-- presenter // presenter component files go here (.html and/or .php)
|           |
|           +-- info.xml  // a "manifest"-file for that plugin
|
+-- index.php

15 März 2024