https://github.com/achttienvijftien/brick
WordPress starter plugin
https://github.com/achttienvijftien/brick
wordpress wordpress-boilerplate
Last synced: 10 days ago
JSON representation
WordPress starter plugin
- Host: GitHub
- URL: https://github.com/achttienvijftien/brick
- Owner: achttienvijftien
- License: gpl-3.0
- Created: 2022-11-11T11:12:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-11T11:17:54.000Z (over 3 years ago)
- Last Synced: 2025-08-26T07:27:19.731Z (10 months ago)
- Topics: wordpress, wordpress-boilerplate
- Language: PHP
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Brick
Brick is a WordPress starter plugin that makes for easy and fast plugin creation.
## Prerequisites
### Basic installation
- PHP >= 8.0
- [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)
### Testing
- Docker
- [nvm](https://github.com/nvm-sh/nvm#install--update-script)
- [Yarn](https://yarnpkg.com/getting-started/install)
## Installation
1. Create a new project using Composer:
```sh
composer create-project achttienvijftien/brick {{name-of-your-plugin}}
```
2. Follow the steps in INITIAL-SETUP.md.
3. Good to go!
## Testing
### Setup
1. Install Composer packages: `composer install`
2. Install the correct Node.js version: `nvm install`
3. Install NPM packages: `yarn`
4. Start wp-env `yarn wp-env start`
5. Check if test suite is ready: `yarn test`
6. When test result is OK you're ready to start writing tests in test/php