diff --git a/README.md b/README.md index 226f9c8..5420fee 100644 --- a/README.md +++ b/README.md @@ -1,134 +1,134 @@ # SucklessPHP - Another PHP framework that sucks less This framework is my laser cannon that I used to develope dozen of very-different Content Management Systems made from scratch. Note that I very often deprecate and kill stuff depending on how I feel in the morning. ## Benefits I can create a RDBMS CMS with these features: * stateless * efficient (very tiny footprint) * [CSRF](https://en.wikipedia.org/wiki/Cross-site_request_forgery)-safe * on demand resource loader (e.g. DB connection is instantiated only if you use it, etc.) * query builder * associative options * database table prefix * login and user capabilities (WITHOUT the need of PHP sessions) * secure file uploads with MIME type checks etc. * multilanguage (using the widely used GNU Gettext native or high-level) ## Requirements Obviously a webserver with PHP and MySQL or MariaDB working. Personally I have a simple GLAMP machine (GNU/Linux + Apache + PHP + MySQL or MariaDB). Extra packages suggested: * `libmagic-dev` The `libmagic-dev` package is in the main Debian GNU/Linux repository and so I think it is in all other GNU/Linux distributions. It is needed only if you need to upload files. ## Simplest shared installation As a shared library: one can serve many sites with a simple `require`. Start cloning the source-code in a shared folder as `/usr/share`: sudo git clone https://github.com/valerio-bozzolan/suckless-php.git /usr/share/php/suckless-php That's it! Leave that folder as is, you don't have to touch it anymore. ## Use it Go to your website folder (e.g. `/var/www/blog`), and create your friendly config file. I use to call it `load.php` and please do so. Write in something as: ```php time; echo "If you see the datetime, the database works!"; ``` ## Database installation You can add support for user *autentication* / user *permissions* and *associative options* importing the database schema into your database. To do it you should have received a file called `example-schema.sql` in the `examples` framework folder. Import it into your database. Actually there are only two tables. ## Stuff in `load.php` Have to specify these: * `$username` (`string`) The database username. * `$password` (`string`) The password of the database username. * `$database` (`string`) The database name. * `$location` (`string`) The database location. * `$prefix` (`string`) The database table prefix. * `ABSPATH` (`string`) The absolute pathname of your site (`__DIR__` is your friend). No trailing slash. * `ROOT` (`string`) The absolute request pathname (something as `/blog` or simply an empty string). No trailing slash. Definibles (as (`type`) `default`): * `DEBUG` (`bool`) `false`: Enable verbose debugging. * `DEBUG_QUERIES` (`bool`) `false`: The queries are logged, and also printed when also `DEBUG`. * `PROTOCOL` (`string`): Default is the protocol of the request (`http://` / `https://`). It builds the `URL` constant. * `DOMAIN` (`string`): Default is your domain name. You can override it. It builds the `URL` constant. * `URL` (`string`): Default is `PROTOCOL . DOMAIN . ROOT`. * `REQUIRE_LOAD_POST` (`string|false`) `string`: As default it's `ABSPATH . '/load-post.php` and it's a file that describes your CMS. ## Website configuration It's normal to have your own custom configuration of this framework. So the `load-post.php` file is made for you. Create it and write in it what you want: ```php 'pdf', 'application/x-pdf' => 'pdf', 'application/x-bzpdf' => 'pdf', 'application/x-gzpdf' => 'pdf' ] ); // my menu tree add_menu_entries( [ // UID URL NAME PARENT new MenuEntry( 'index', 'home.php', __("Home") ), new MenuEntry( 'services', 'services.php', __("Our services") ), new MenuEntry( 'contact', 'meet.php', __("Meet us"), 'services'), new MenuEntry( 'fsf', 'https://fsf.org/', __("Meet us in Colorado"), 'contact'), ] ); ``` ## Hacking See [DEVELOPING.md](./DEVELOPING.md). ## License Copyright (c) 2015-2019 [Valerio Bozzolan](http://boz.reyboz.it/) This is a **Free** as in **Freedom** project. It comes with ABSOLUTELY NO WARRANTY. You are welcome to redistribute it under the terms of the **GNU General Public License v3+**.