The 100% Original Theme for LezWatch.TV
Based on the Yikes! Starter Theme, the LezWatch.TV theme has been customized for custom post types (shows, characters, actors), and is fully integrated with the LezWatch.TV Plugin.
It's recommended to use Homebrew on macOS or Chocolatey for Windows to install the project dependencies.
- Clone this repository:
git clone [email protected]:lezwatch/lwtv-underscores
- Move into the project directory:
cd lwtv-underscores
- Install the project dependencies:
npm install
All pull requests should be made to production.
- Using the
production
branch as base, create a new branch with a descriptive name likefixing-charts
orfix/chartjs421
orfeature/latest-posts
. Commit your work to that branch until it's ready for full testing - Open a pull request from your feature branch to the
production
branch. - If you are not a main developer, your pull request will be reviewed before it can be merged. If there are issues or changes needed, you may be asked to do so, or they may be done for you.
- When the code passes review, run
npm run merge-to-develop
to push it to development (no extra PR needed). - Once the code passes tests and is approved, the branch can be merged into
production
and the job is done!
To install and update:
$ npm install
- Install all the things.$ npm updater
- Updates all the things.$ npm build
- Builds all the CSS and handles composer versions.
Commits are currently not linted by default.
If you're updating CSS you have a couple options, since it's all SCSS:
grunt watch
- run grunt and leave open for ongoing changes.grunt build
- run the build process once.
This will also update any needed internal javascript.
JS libraries are included via NPM.
The vendor
and node_module
files are not synced to Github, to minimize the amount of files stored on the servers.
Pushes to branches are automatically deployed via Github Actions as follows:
- Development: lezwatchtvcom.stage.site (password required - Ask Mika)
- Production: lezwatchtv.com
- Supports three Custom Post Types and related taxonomies: Characters, Themes, Actors
- Integrated with LWTV Plugin (
lwtv_plugin()->FUNCTION()
) - Integrated with FacetWP, Jetpack Instant Search, and CMB2.
- Additional custom image sizes: Show (960x400), Character (225x300), Actor (225x300)
- Additional custom sidebars: Show, Character, and Actor Archives
- Widgets: Display latest custom post type posts (show and character) with image