tobybutchart / swat Goto Github PK

Report an Issue · Releases · Change Log

Description · Roadmap

A Simple-Web-and-API-Template

SWAT is a web template for getting simple sites up and running quickly with PHP.

SWAT includes a log viewer, login functionality, custom 404 pages and an API suite.

To use SWAT download the latest release, and customise the following:

• 404\404_controller.php (this is your custom 404 page)
• components\header.php (the header to be displayed on all pages)
• components\footer.php (the footer to be displayed on all pages)
• login\login_controller.php (this is your custom login page - optional)
• pages\index.php (this will be your front page)

Once the above is complete, to add a new page, create a file in the pages directory with the name of the URI you wan to point to that page.

E.g.: create pages\hello-world.php containing the following:

<h1>Hello World!</h1>
<p>Welcome to SWAT</p>

This will produce the following from https://URL/hello-world - the header and footer will be injected automatically.

For nested pages, add a directory that you want the URI to become (this is useful for grouping functionality).

E.g.: a file created in: \shop\products\wood.php will create the following URI https://URL/shop/products/wood

SWAT uses Bootstrap 5, so all valid Bootstrap classes are available.

The configuration for a page is set in config\pages.ini and is used to define the functionality of each page. This is set for the whole website within the [global] section, but can be overridden on a page by page basis using the pages URI as the section header i.e. [hello-world] will override settings for the page https://URL/hello-world - any settings not overridden will be picked up by the global section. To understand what can be configured see the comments in config\pages.ini:

Cache-breakers are included in the config file config\versions.ini and are added as a trailing query param to all JS and CSS files. To force a browser to re-pull all cached CSS, update the version number in the CSS key:

Any URIs requested that do not exist will be routed to a custom 404 page, and will be logged. To see logs, go to logs\yyyy\mm\dd to view.

A log viewer is available by default so issues can be looked at without server access. To view your logs navigate to https://URL/logs. This will need a login set up in config\credentials.ini.

A login system exists in SWAT for both internal users and external users. To change the login functionality alter the users API in api\users\get.php.

An API framework exists in SWAT and can be used in a similar way to the pages. To create a new API, add a file to the api directory, the API URI will be dictated by the file name. i.e. api\products\get.php will translate to https://URL/api/products/get.

To extend the functionality of a page/pages add a directory with the intended URI with a file inside called DIRECTORY_controller.php, i.e. \products\products_controller.php. This will override any pages with the same URI (https://URL/products), meaning all functionality is pulled from the PHP controller. See 404\404_controller.php for a working example.