Qlicksoft CMS File Layout

This is the file architecture used in Qlicksoft CMS. You will need to know this to find things to adapt and change. When you install software to run Qlicksoft CMS, do it in this file layout to make life easier. As you can see, it is very easy to understand and was purposely arrange in this manner.

We are assuming that you are using an Apache HTTP server and that /var/www happens to be its root in a virtual host setup. If this isn't the case, please arrange under your server's document root to mimic this layout for best results.

/var/www/domain.com
   .htaccess
   config.php
   main.php
   utils.php
   /content
      /documents
         front.php.content
         /site
            front.php.content         
            404.php.content
            about.php.content
            privacy-policy.php.content
            terms-of-use.php.content
         /yourcategory
            front.php.content
            title-of-doc.php.content
      /images
         /yourcategory
   /library
      /language
         en.php.lang
      /snippets
         datetime.php.snippet
      /tools
         codeToHtml5.php
      /themes
         /qlick
            theme.main.php
            /css
               responsive.css
               styles.css
            /images
               logo.png
            /templates
               front.home.mustache
               front.category.mustache
               article.mustache
               article.sidebarLeft.mustache
               article.sidebarRight.mustache
               simple.mustache
               simple.sidebarLeft.mustache
               simple.sidebarRight.mustache
            /starters
               article.php.content
               article.sidebarLeft.php.content
               article.sidebarRight.php.content
               simple.php.content
               simple.sidebarLeft.php.content
               simple.sidebarRight.php.content
   /templateEngine
      /bin
      /src
   /theme

Main Directory

The main virtual host directory contains .htaccess used for routing to main.php, the configuration file, and a utility module. These are the main Qlicksoft CMS files that drive it to be a database-less micro CMS.

Library Directory

Used to keep copies of themes, tools, language, and snippets.

Content Directory

Content is stored under the content folder. The documents and images folders reside underneath it. Categorical content is subfolders of the documents folder.

So for example, the default site folder already exist. To create your own, say sports, create a /var/www/content/documents/sports folder. Then, create content files in it along with the resources it uses (like video, pdf, images, etc.)

Language Directory

The language directory is where the specific language strings reside. We only supply one, en.php.lang, but you are free to create your own. Please use BCP47 language country code to preface the filename.

TemplateEngine Directory

The mustache template engine is in the templateEngine folder. This is the entire PHP Mustache project from GitHub as of last commited update July 11, 2017. This is made available under a MIT license by Justin Hileman.

Themes Directory

The themes directory contains all your installed themes. By default, the Qlick theme is supplied. Everything should go into a theme folder and preferrably, not have subfolders in it. That will make it easier to generate paths to it from your files.

Tools Directory

Finally, any code used for utility purposes should reside in the tools folder.

It is important to note here that access to these files from a web user perspective is only done through a .htaccess that is set to route everything into our main.php router. From a web administrator access point, its done through the terminal.