/flywork-poc

Flywork Framework - Proof of Concept Project

Primary LanguagePHP

Flywork

Flywork - PoC

Flywork Framework - Proof of Concept Project

This project is an example showing how the Flywork framework works.

Default Namespace

The default application namespace should be "App\", which allows Composer and PSR-4 to correctly handle classes.

Minimal File Structure

  • /public
    • /bundles
    • .htaccess
    • index.php
  • /src
    • /Controllers
      • /Rest
    • /Models
    • /Views
  • /writable
    • /cache
    • /logs
    • /upload

Folders and root files explaining

/public

    You should put web assets (css, js, img, etc) in this folder. Organize it as you want, but keep in mind that these files are accessible via HTTP requests.
    The files .htaccess and index.php are essential to run the application.

/public/bundles

    Contains all generated bundles (combination of files - CSS or JS)

/src

    Contains application source code.

/src/Controllers

    Contains all application web controllers.

/src/Controllers/Rest

    Contains all application RESTful controllers.(which will be called through url /rest/controller-name/action)

/src/Models

    Contains applications models, which handles database entities and data manipulation.

/src/Views

    Contains all application views (you can organize it in subfolders).

/writable

    This folder is necessary to put all files which is written by framework.
    Should contains cache, logs and upload subfolders and be setted as writable.

/composer.json

    Main composer application file.

/flywork.sql

    Sample database script.