Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/somoscuatro/homebrew-wp-project-scaffold
Scaffolds a WordPress project using Docker and optionally a starter theme
https://github.com/somoscuatro/homebrew-wp-project-scaffold
brew homebrew-formula wordpress wordpress-scaffolding
Last synced: 24 days ago
JSON representation
Scaffolds a WordPress project using Docker and optionally a starter theme
- Host: GitHub
- URL: https://github.com/somoscuatro/homebrew-wp-project-scaffold
- Owner: somoscuatro
- License: other
- Created: 2024-06-06T12:21:46.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-07T18:50:40.000Z (5 months ago)
- Last Synced: 2024-10-04T21:43:16.461Z (about 1 month ago)
- Topics: brew, homebrew-formula, wordpress, wordpress-scaffolding
- Language: Shell
- Homepage: https://somoscuatro.es
- Size: 45.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WordPress Project Scaffold
This tool provides a streamlined and opinionated approach to kickstart a local
development environment for your WordPress project. It's designed to save you
time and effort, allowing you to focus on building your WordPress site right
away.
## Prerequisites
Before you begin, ensure you have the following prerequisites installed and
configured on your system:
- [Docker Engine](https://docs.docker.com/engine/install/): For container
management. We recommend using [OrbStack](https://orbstack.dev/) for a faster
and more efficient alternative.
- [mkcert](https://github.com/FiloSottile/mkcert): For creating locally trusted
SSL certificates.
Also ensure that your `/etc/hosts` file includes the entry `127.0.0.1
your-project.test`. Alternatively, you can automate this process using a tool
like [Dnsmasq](https://thekelleys.org.uk/dnsmasq/doc.html).
## Installation
To install the WordPress Project Scaffold, follow these steps:
1. Add the custom Homebrew tap:
```shell
brew tap somoscuatro/homebrew-wp-project-scaffold
```
2. Install the wp-project-scaffold tool via Homebrew:
```shell
brew install wp-project-scaffold`
```
## Usage
To initiate your WordPress project, simply execute the following command:
```shell
wp-project-scaffold
```
Running this command will:
Set up a local WordPress development environment using the [somoscuatro Docker
Compose configuration](https://github.com/somoscuatro/docker-wordpress-local).
Optionally, install the [somoscuatro WordPress Starter
Theme](https://github.com/somoscuatro/sc-starter-theme) to jumpstart your theme
development. For more detailed information and advanced usage, please refer to
the respective GitHub repositories linked above.
Credentials to access `/wp-admin` are:
- username: `admin`
- password: `admin`
Happy coding, and enjoy building your WordPress site with ease!
## How to Contribute
Any kind of contribution is very welcome!
Please, be sure to read our [Code of
Conduct](https://raw.githubusercontent.com/somoscuatro/homebrew-wp-project-scaffold/main/CODE_OF_CONDUCT.md).
If you notice something wrong please open an issue or create a Pull Request or
just send an email to [[email protected]](mailto:[email protected]). If you
want to warn us about an important security vulnerability, please read our
Security Policy.
## License
All code is released under MIT license version. For more information, please
refer to
[LICENSE.md]((https://raw.githubusercontent.com/somoscuatro/homebrew-wp-project-scaffold/main/LICENSE.md))
file.