Menu

Tree [52c985] master /
 History

HTTPS access


File Date Author Commit
 class 2012-01-30 Bruno Beauvais Bruno Beauvais [52c985] The first version with documentation and test c...
 core 2012-01-30 Bruno Beauvais Bruno Beauvais [52c985] The first version with documentation and test c...
 doc 2012-01-30 Bruno Beauvais Bruno Beauvais [52c985] The first version with documentation and test c...
 lang 2012-01-24 Bruno Beauvais Bruno Beauvais [af0fef] First commit. A simple MVC framework without Da...
 nbproject 2012-01-30 Bruno Beauvais Bruno Beauvais [52c985] The first version with documentation and test c...
 ressource 2012-01-30 Bruno Beauvais Bruno Beauvais [52c985] The first version with documentation and test c...
 ReadMe.html 2012-01-30 Bruno Beauvais Bruno Beauvais [af4067] The first version with documentation and test c...
 config.ini 2012-01-30 Bruno Beauvais Bruno Beauvais [52c985] The first version with documentation and test c...
 index.php 2012-01-30 Bruno Beauvais Bruno Beauvais [52c985] The first version with documentation and test c...

Read Me

<!--
Copyright Beauvais Bruno
This file is part of MVC-simple.

    Foobar is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Foobar is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Foobar.  If not, see <http://www.gnu.org/licenses/>-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<html>
  <head>
    <title>MVC Simple - Readme</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <style>
        body {margin : 20px 200px 20px 200px}
        p { text-align: justify; text-indent: 40px}
        
        h1 {text-align: center; 
            padding: 20px 0 20px 0;
            border-bottom: 2px solid black;
            border-top: 2px solid black;
        }
    </style>
  
  </head>
  <body>
      <h1>MVC Simple - Readme</h1>
      <p>MVC simple is an open source project with a <a href="http://www.gnu.org/copyleft/gpl.html">GNU General Public License</a>. The objective of this project is to provide a very simple, small  and complete PHP framework to develop web server. An other objective is to build a code the must readable as possible. This framework is indicated to build prototypes to test interfaces or technologies. The framework is develop with the IDE Netbeans and the distributed revision control Gits.</p>
      The features :
      <ul><li>Application logic separated from the presentation layer</li>
          <li>Object-oriented programming</li>
          <li>include test engine for unit tests and scenarios</li>
          <li>An abstract layer to manipulate MyQSL server</li>
      </ul>
      
      <p>Why develop in PHP and MySQL ? This technologies are <a href="http://www.tiobe.com/index.php/content/paperinfo/tpci/index.html">very popular</a> and are <a href="http://w3techs.com/technologies/details/pl-php/all/all">the must common in internet</a>. Why use this framework rather an other one ? The MVC-simple is very light and small, more than <a href=''>the other frameworks</a>. We hope also that the code is very easy to read from non specialist in PHP. If your project is complex, need performance or security, MVC-Simple is not for you. There is many powerfull PHP framework : Symfony or Zend are the most popular. But you must know that the formation fopr this technolies last several months.</p>

<p>I hope this framework will be helpfull in your projects,</p>

<i>Bruno Beauvais - beauvaisbruno@google.com</i>

<h2>Prerequisite</h2>

<p>You need to have access to web server supporting PHP version 5 and a mySQL server version 5.</p>


<h2>How to install a MVC-simple project?</h2>

<p>First you need to have access to a databse in MySQL server. You may create a database for MVC-simple. Next, open config.ini and set this proprieties : </p>
<code>
[install]<br/>
server=localhost<br/>
<br/>
// It's the uri of the MySQL server, if you don't now what is an uri you should <br/>
//let localhost<br/>
<br/>
database=<br/>
// It's the name of the database in the MySQL server. If you don't have any databse<br/>
// yest, you have to create one.<br/>
<br/>
user=<br/>
pass=<br/>
// It's your login and your password to connect to your database, if you subscribe<br/>
// to a host site, your must received a mail with this informations.<br/>
</code><br/>

<p>Now, you have to upload the file to your webserver. You can use a FTP client, for example : FileZilla. If you have subscribed to a host site, check you mail to get the login, the password and the URL to connect to your FTP account. Usually, the files have to be upload in the public_html folder to be visible from internet. Go to the URL of your webserver to check</p>

<h2>Get started with MVC-Simple</h2>
<p>The best way is to look /class/sample/sample.php. All the documentation generated by PhpDocumentor is available here <a href="doc/">/doc/</a>. You can add your files anywhere in /class/ or in his subfolder. I advise you to name your class and your file in the same way as in the JAVA language, but it's not an obligation.</p>

<h2>How test my code ?</h2>

<p>MVC simple has a test engine similar as Junit, look at /class/sample/sample.php. To launch all your test, acces a this adress <a href="index.php?test=">[root]/index.php?test=</a>. </p>

  </body>
</html>