Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code


  • Loading branch information...
commit b057c089c9634f1f2dde48ada46188a63a94f037 1 parent 313b1b8
Juan Manuel Pereyra authored

Showing 1 changed file with 26 additions and 0 deletions. Show diff stats Hide diff stats

  1. +26 0 README.markdown
26 README.markdown
Source Rendered
... ... @@ -0,0 +1,26 @@
  1 +This is a simple lightweight PHP MVC Framework
  2 +
  3 +Even if it's currently implemented in a couple of mid-sized online projects, it's far from a PRO project, so any corrections/comments are welcome!
  4 +
  5 +I also know that it's kinda poorly documented, so any help is welcome too!
  6 +
  7 +To put it working:
  8 +
  9 +* Make sure you have apache2's mod-rewrite enabled, and your Allow Override directives enabled for your site.
  10 +* Copy "system" directory, "index.php" and ".htaccess" (this last one can be replaced by copying it's contents to apache config) to your site root.
  11 +* Create a directory named "source" on the same level of your "system" directory.
  12 +* Copy the directory structure inside "example" to "source".
  13 +* Configure the contents of the config directory according to your site directives.
  14 +* Create a controller file (a good idea is to match your default controller configuration).
  15 +* Files should ALWAYS be lowercase (home.php) but class definitions should be camelcase standard (class Home extends Controller), and that's true for ANY class in the FW
  16 +* Open your controller file and define a class matching filename (class FileName extends Controller) with an "index" method (index methods are the ones invoked when no explicit method is called in url).
  17 +* Your urls will be like "http://siteDomain/controller/method/param1/param2/..."
  18 +* You're set to start testing!! (You then can start trying Models, Views, etc, I should upload examples later).
  19 +
  20 +* A good advice is that you can set the SYSTEM_DEBUG to "true" in system/core/definitions.php to get a (very rudimentary) system loading debug log.
  21 +
  22 +TO-DOS:
  23 +
  24 +- Improve FW documentation.
  25 +- Fix an answer bug regarding the names for the $_SERVER["PATH_INFO"] variable being different in the various httpd implementations.
  26 +- I use a great framework for Mailing (Swift) but we have to externalize it in opposition to adding it to our system core.

0 comments on commit b057c08

Please sign in to comment.
Something went wrong with that request. Please try again.