Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wordpress/wporg-showcase-2022
The official theme of the WordPress.org showcase.
https://github.com/wordpress/wporg-showcase-2022
theme wordpress wporg
Last synced: about 1 month ago
JSON representation
The official theme of the WordPress.org showcase.
- Host: GitHub
- URL: https://github.com/wordpress/wporg-showcase-2022
- Owner: WordPress
- Created: 2022-09-21T06:37:12.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T19:20:18.000Z (about 2 months ago)
- Last Synced: 2024-10-07T09:39:27.767Z (about 1 month ago)
- Topics: theme, wordpress, wporg
- Language: PHP
- Homepage: https://wordpress.org/showcase/
- Size: 3.95 MB
- Stars: 20
- Watchers: 16
- Forks: 5
- Open Issues: 28
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Showcase Block Theme
A block-based child theme for WordPress.org Showcase, plus local environment.
This is as-yet incomplete, a starting point.
## Development
### Prerequisites
* Docker
* Node/npm
* Yarn
* Composer
### Setup
1. Set up repo dependencies.
```bash
yarn
composer install
yarn setup:tools
```
1. Start the local environment.
```bash
yarn wp-env start
```
1. Run the setup script.
```bash
yarn setup:wp
```
1. (optional) There may be times when you want to make changes to the Parent theme and test them with the Main them. To do that:
1. Clone the Parent repo and follow the setup instructions in its `readme.md` file.
1. Create a `.wp-env.override.json` file in this repo
1. Copy the `themes` section from `.wp-env.json` and paste it into the override file. You must copy the entire section for it to work, because it won't be merged with `.wp-env.json`.
1. Update the path to the Parent theme to the Parent theme folder inside the Parent repository you cloned above.
```json
{
"themes": [
"./source/wp-content/themes/wporg-showcase",
"./source/wp-content/themes/wporg-showcase-2022",
"../wporg-parent-2021/source/wp-content/themes/wporg-parent-2021"
]
}
```
1. Visit site at [localhost:8888](http://localhost:8888).
1. Log in with username `admin` and password `password`.
### Environment management
These must be run in the project's root folder, _not_ in theme/plugin subfolders.
* Stop the environment.
```bash
yarn wp-env stop
```
* Restart the environment.
```bash
yarn wp-env start
```
* Build the theme's JavaScript
```bash
yarn workspace wporg-showcase-2022-theme build
```
or, automatically build on changes:
```bash
yarn workspace wporg-showcase-2022-theme start
```
* Reset WordPress to a clean install, and reconfigure. This will nuke all local WordPress content!
```bash
yarn wp-env clean all
yarn setup:wp
```
* SSH into docker container.
```bash
yarn wp-env run wordpress bash
```
* Run wp-cli commands. Keep the wp-cli command in quotes so that the flags are passed correctly.
```bash
yarn wp-env run cli "post list --post_status=publish"
```
* Update composer dependencies and sync any `repo-tools` changes.
```bash
yarn update:tools
```
* Run a lighthouse test.
```bash
yarn lighthouse
```
* Check visual diffs.
Backstopjs can be manually run to create reference snapshots and then check for visual differences.
```bash
yarn backstop:reference
# change something in the code or content
yarn backstop:test
```