SITE | URL |
---|---|
Local | http://kms.test |
DEV | [To Come] |
LIVE | https://kempmanagementsolutions.net/ |
- Based on Bedrock
- Dependency management with Composer
- WordPress configuration with environment specific files
- Environment variables with Dotenv
- Autoloader for mu-plugins (use regular plugins as mu-plugins)
- Enhanced security (separated web root and secure passwords with wp-password-bcrypt)
- Ensure that your local vhost docroot (apache/nginx document root) is set to
web
- Create
.env
file matching your environment details. Put this file into the root of the project. Please use.env.example
file for reference. - Start terminal and navigate to project root.
- Run
composer install
- Navigate to theme directory
cd web/app/themes/kms
- Run
npm install
- Make style updates here:
web/app/themes/kms/sass/theme/_theme.scss
- Add custom scripts here:
web/app/themes/kms/src/js/main.js
- NOT IN INDIVIDUAL PHP FILES - Compile your Sass changes with Gulp by running:
gulp watch
- If you want to use BrowserSync, edit the proxy value at the top of
web/app/themes/kms/gulpconfig.json
("proxy": "http://wp-starter.test/",
) so your browser will auto reload on update if you rungulp watch-bs
instead ofgulp watch
- Read theme documentation here for more tips Understrap.github.io
Both WordPres Core and most non-premium plugins are tracked by composer so updates should be done in the root composer.json
file. To update:
- Confirm the latest version is available on WP Packagist
- Update
composer.json
with new packagist requirements - Run
composer update
to get new versions which will updatecomposer.lock
- Commit the updated composer files to the repo
- Add any externally hosted JS & CSS assets to the
web/app/themes/kms/inc/enqueue.php
file - Any Google Fonts should be includes as
@import
statements withinweb/app/themes/kms/src/sass/theme.scss
-- see example on line 19
- Add new CPT references here:
web/app/mu-plugins/tele-custom/index.php
- Add new CPT defintion file here:
web/app/mu-plugins/tele-custom/cpt/cpt-[name].php
- A Jenkins project will be set up for this project
- Email sends are setup through a SendGrid API Key and utilize the WP Sendmail plugin. You will need to request a client SendGrid account.
- If the site includes maps or geocoding, a Google Maps/Geocode API Key will need to be set up.
This starter uses generic text in several places both for descriptions and file names (such as theme name). This needs to be updated to match project naming. Some known replacements:
.gitignore
: update "telestar" theme name to actual theme name if changedcomposer.json
: update project name, details, URL, etc.env (from .env.example)
: update database name & WP_HOME globalweb/app/themes/telstar/gulpconfig.json
: update proxy to local test env