resknow / boilerplate
Boilerplate - A PHP boilerplate that takes the faff out of developing websites.
Installs: 66
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Language:HTML
Type:project
Requires
- php: ^7.1
- bramus/router: 1.4.2
- filp/whoops: 2.5
- mustangostang/spyc: 0.6.3
- resknow/boilerplate-core: ^4.1.1
- twig/twig: 2.11
README
The Config File
Outlined below are the default values that appear on a fresh Boilerplate site. Plugins may define their own values so you will need to refer to the docs for those plugins.
Key | Description |
---|---|
admin_mode |
When set to true , will display an Admin UI for installing plugins, only works on localhost and when environment === dev |
url |
The site's full URL, including protocol. e.g. https://example.co.uk |
company |
The company/site name |
email |
Site e-mail address, required by the Form plugin |
environment |
Current site environment, used by Boilerplate and plugins to determine whether you're developing or if the site is live. Use dev or prod . |
force_url |
Only used if environment === prod . Forces the site url for all requests. |
analytics |
Google Analytics property ID, required by Google Analytics plugin, not used otherwise. |
stylesheets |
Site-wide stylesheets, add in key value pairs e.g. main: ~/css/style.css the ~ character is used to represent the assets_dir , which is /_templates/assets by default. |
forms |
Configuration for your forms, see the Form plugin docs for full documentation. |
Local Server
If you have PHP installed on your local machine, you can use the built-in local server to test your Boilerplate site. To do so, open your terminal and cd
in to your site's directory and run php serve
. Your site will now be running on localhost:8000
. To stop the local server, type Ctrl + C
in the terminal.