Setup

Download the framework code.

Create a folder for your project, e.g.

/www/live/framework/
/www/live/test.project/

Then in the terminal, cd into your project folder and run the command:

../framework/framework/0.1/cli/run.sh -i

This will automatically create the files and folders for the site structure.

For the web server config, use one of the examples for Apache or Nginx.

You can now create a very simple view file, e.g.

/app/view/home.ctp

Or customise the overall page template:

/app/template/default.ctp

For dynamic content, create units, which can be loaded by controllers.

And during development, it is worth enabling debug mode.

When your are ready to upload to a server, look at the uploading process.

As an aside, the framework itself is not built in a typical MVC structure, and only borrows ideas that are appropriate for a web based system.

Instead code is broken down into multiple components:

  1. Routes - rarely used.
  2. Controllers - selects and configures the appropriate unit(s).
  3. Units - a thing on the page (form, table, etc).
  4. Helpers - typically used by units.
  5. Views - for simple pages.
  6. Templates - for the overall page (generic to the whole site).
  7. Resources - for CSS, JS, favicon.ico, robots.txt, sitemap.xml.
  8. Gateways - for API's.
  9. Jobs - like cron jobs.