https://github.com/boxuk/wp-project-skeleton
A skeleton WordPress project to be used as a base for new WordPress projects.
https://github.com/boxuk/wp-project-skeleton
wordpress wordpress-boilerplate wordpress-development
Last synced: 3 months ago
JSON representation
A skeleton WordPress project to be used as a base for new WordPress projects.
- Host: GitHub
- URL: https://github.com/boxuk/wp-project-skeleton
- Owner: boxuk
- License: gpl-2.0
- Created: 2021-06-23T11:10:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T16:37:26.000Z (9 months ago)
- Last Synced: 2024-10-29T14:14:52.647Z (9 months ago)
- Topics: wordpress, wordpress-boilerplate, wordpress-development
- Language: PHP
- Homepage:
- Size: 3.76 MB
- Stars: 50
- Watchers: 13
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BoxUK WordPress Project Skeleton
A base WordPress project from Box UK to get you up and running quickly.
## [📚 Read the docs](https://boxuk.github.io/wp-packages/)
## Installation
Create a new project with composer
```bash
composer create-project boxuk/wp-project-skeleton my-project --stability=dev
```
Install with the simple install script
```bash
bin/install --project=[project_name] --network=[docker_network_name] --php=[php_version]
```
All arguments are optional.
Defaults:
- Project Name = boxuk-wp-skeleton
- Network Name = boxuk-docker
- PHP Version = 8.2
> Note: This is an interactive command.
## Usage
Frontend:
[https://my-project.local](https://my-project.local)
Admin:
[https://my-project.local/wp-admin](https://my-project.local/wp-admin)
If you need to update the admin password, you can run the following WP-CLI command:
```sh
bin/docker/wp user update admin --user_pass=your_password_here
```
## Features
📕 - Fully [documented](https://boxuk.github.io/wp-packages/docs/skeleton/).
🐳 - Fully dockerized setup
📦 - Composer based plugin management
🧠 - Xdebug installed by default
📋 - Configurable state across environments (WIP)
🪜 - Customisable fixtures support using the WP CLI (WIP)
🚩 - First class support for feature flags using [wp-feature-flags](https://github.com/boxuk/wp-feature-flags)
✅ - Unit, Integration and Visual Regression testing support
> You can read more about all of these features in [this post on the Box UK blog](https://www.boxuk.com/insight/how-we-develop-wordpress-sites/).
## License
[GPLv2](https://choosealicense.com/licenses/gpl-2.0/)