Mutual Aid NYC WordPress Theme
A WordPress theme developed for Mutual Aid NYC, using the parent theme TwentyTwenty.
Development
This project requires:
- Node.js (latest LTS version)
- Yarn
- Docker
- Basic knowledge of WordPress
- NVM (optional)
- Composer (optional)
To install this project:
- Clone this repo to a directory and
cd
into it.
- Install dependencies with
yarn
.
- Initialize the site with
yarn wp-env start
.
- Access the site at
localhost:8888
. The default user is admin
, password password
.
- Install the following plugins: AirPress, Jetpack, Gutenberg, TranslatePress (optional).
- Build the blocks via the following command:
yarn build
.
- Activate the Mutual Aid NYC theme in the admin.
- Optional: Export the site from production or stage, and import via the WordPress importer tool.
- Optional: Run
composer install
from repo root to install PHP linting tools. Linting can be run via composer run-script php:lint
.
Release Process
The release process is mostly automated, being driven by GitHub Actions for the most part.
Required:
- GitHub maintainer access for this repo
- Production WordPress admin level access.
- Ensure current
main
branch has tests currently passing.
- Create a new release in GitHub with a new tag for the released version.
- Set the description to link to the currently open milestone.
- A new theme package will be built, and attached to the new release as
mutualaidnyc.zip
. Progress can be monitored here.
- Download the package zip file and upload it via the production Wordpress admin.
- Create a new Milestone in GitHub with the next release version.
- Notify people in Slack with the appropriate amount of emoji. 🎉