{{Brief description of this theme}}. Built as a child theme of the UCF WordPress Theme, using the Athena Framework.
Head over to the {{My Project}} wiki for detailed information about this theme, installation instructions, and more.
Note that compiled, minified css and js files are included within the repo. Changes to these files should be tracked via git (so that users installing the theme using traditional installation methods will have a working theme out-of-the-box.)
Enabling debug mode in your wp-config.php
file is recommended during development to help catch warnings and bugs.
- node
- gulp-cli
-
Clone the {{My-Project}} repo into your local development environment, within your WordPress installation's
themes/
directory:git clone https://github.com/UCF/{{My-Project}}.git
-
cd
into the new {{My-Project}} directory, and runnpm install
to install required packages for development intonode_modules/
within the repo -
Optional: If you'd like to enable BrowserSync for local development, or make other changes to this project's default gulp configuration, copy
gulp-config.template.json
, make any desired changes, and save asgulp-config.json
.To enable BrowserSync, set
sync
totrue
and assignsyncTarget
the base URL of a site on your local WordPress instance that will use this theme, such ashttp://localhost/wordpress/my-site/
. YoursyncTarget
value will vary depending on your local host setup.The full list of modifiable config values can be viewed in
gulpfile.js
(seeconfig
variable). -
Run
gulp default
to process front-end assets. -
If you haven't already done so, create a new WordPress site on your development environment, and install and activate theme dependencies.
-
Set {{My Project}} as the active theme.
-
Make sure you've completed all theme configuration steps.
-
Run
gulp watch
to continuously watch changes to scss and js files. If you enabled BrowserSync ingulp-config.json
, it will also reload your browser when scss or js files change.
Want to submit a bug report or feature request? Check out our contributing guidelines for more information. We'd love to hear from you!