{{My Project}}

{{Brief description of this theme}}. Built as a child theme of the UCF WordPress Theme, using the Athena Framework.

Quick links

• Theme Documentation
• Development
• Contributing

---

Documentation

Head over to the {{My Project}} wiki for detailed information about this theme, installation instructions, and more.

---

Development

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.

Requirements

• node v16+
• gulp-cli

Instructions

1. 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

2. cd into the new {{My-Project}} directory, and run npm install to install required packages for development into node_modules/ within the repo

3. 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 as gulp-config.json.

   To enable BrowserSync, set sync to true and assign syncTarget the base URL of a site on your local WordPress instance that will use this theme, such as http://localhost/wordpress/my-site/. Your syncTarget value will vary depending on your local host setup.

   The full list of modifiable config values can be viewed in gulpfile.js (see config variable).

4. Run gulp default to process front-end assets.

5. If you haven't already done so, create a new WordPress site on your development environment, and install and activate theme dependencies.

6. Set {{My Project}} as the active theme.

7. Make sure you've completed all theme configuration steps.

8. Run gulp watch to continuously watch changes to scss and js files. If you enabled BrowserSync in gulp-config.json, it will also reload your browser when scss or js files change.

Contributing

Want to submit a bug report or feature request? Check out our contributing guidelines for more information. We'd love to hear from you!