This page is about the folders a website with Kiwa has.
assetsfolder contains a few subfolders that may be
stylesheetsand so on. This a mostly the raw data like
- Inside the
configfolder is all configuration data stored. Kiwa uses a
config.phpfile, this may also be a
htmlis the place for all page content. Kiwa uses
phtmlfiles containing PHP and HTML code.
- If you use translations, there is a folder called
languageto store all translation data. Every language has its own file, for example
publicfolder is where your domain points to. So this folder is accessible from the outside, every other is not. The
publicfolder must contain a
index.phpand should also have a
- In the
srcfolder you may place custom code, for example your own PHP classes. They will be autoloaded automatically as long as the use the namespace
testsfolder has mostly the same structure as the
srcfolder and contains tests. PHPUnit is a root dependency of Kiwa and is ready to test the behaviour of all PHP code.
- Kiwa caches and logs data, that's what the
varfolder is made for. It contains a
cachefolder for all pure HTML files and a
logfolder where debugging and error reporting goes into.
Dependencies and their managers
- If you want to use Node for your JS and CSS dependencies, there will be a folder
node_modules. It cames from NPM or Yarn.
vendorfolder comes from Composer and contains all PHP dependencies. It must not edited or changed.
If you make use of the Kiwa Console module, you will have a
bin folder containing the
The Console is very useful to create pages, start a local server, or validate your config.
You can find more information under bitbucket.org/wirbelwild/kiwa-console.
If you make use of the Kiwa Sitemap module, there may be the additional
With the Kiwa Console, the Sitemap module can be triggered to create a full
sitemap.xml file, containing all public pages with their image content. The sitemap module splits them by their languages and creates also a link in the
You can find more information under bitbucket.org/wirbelwild/kiwa-sitemap.