ucf / bot-utilities
Provides extra functionality and utilities for the BOT website.
Requires
- composer/installers: ~1.0
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-10-20 18:13:48 UTC
README
Provides extra functionality and utilities for the BOT website.
Description
Provides extra functionality and utilities for the BOT website.
Documentation
Head over to the BOT Utilities wiki for detailed information about this plugin, installation instructions, and more.
Changelog
1.0.5
Enhancements:
- Added composer file.
1.0.4
Enhancements:
- Updated people-list shortcode output for Athena v1.1.1+ compatibility
- Upgraded packages
1.0.3
Bugfix:
- Fixed issue where the people-list shortcode was not displaying leadership in their committee assignments.
1.0.2
Bugfix:
- Fixed issue where the people-list shortcode was not displaying properly if list was not even.
1.0.1
Documentation:
- Updated contributing doc to reflect migration from slack to teams.
1.0.0
- Initial release
Upgrade Notice
n/a
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 plugin using traditional installation methods will have a working plugin 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
-
Clone the BOT-Utilities repo into your local development environment, within your WordPress installation's
plugins/directory:git clone https://github.com/UCF/BOT-Utilities.git -
cdinto the new BOT-Utilities directory, and runnpm installto 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
synctotrueand assignsyncTargetthe base URL of a site on your local WordPress instance that will use this plugin, such ashttp://localhost/wordpress/my-site/. YoursyncTargetvalue will vary depending on your local host setup.The full list of modifiable config values can be viewed in
gulpfile.js(seeconfigvariable). -
Run
gulp defaultto process front-end assets. -
If you haven't already done so, create a new WordPress site on your development environment to test this plugin.
-
Activate this plugin on your development WordPress site.
-
Configure plugin settings from the WordPress admin under "BOT Utilities".
-
Run
gulp watchto continuously watch changes to scss and js files. If you enabled BrowserSync ingulp-config.json, it will also reload your browser when plugin files change.
Other Notes
- This plugin's README.md file is automatically generated. Please only make modifications to the README.txt file, and make sure the
gulp readmecommand has been run before committing README changes. See the contributing guidelines for more information.
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!