Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

Commit 6c790c6

Browse files
author
Sara Lovell
committed
add docker compose details and usage instructions
1 parent 933b58c commit 6c790c6

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,22 @@ At a glance, with WP CC Plugin you can:
112112
Contributions will be very appreciated. See
113113
[`CONTRIBUTING.md`](CONTRIBUTING.md).
114114

115+
### Using a localized Docker Setup
116+
117+
A local `docker-compose.yml` file is included in the `./dev/` directory. It includes an Apache webserver, the latest WordPress installation files, and a mySQL db server utilizing MariaDB.
118+
119+
To run a local development environment for building and testing contributions you can run the following pattern from the root directory of this repository after cloning it.
120+
121+
`docker compose -f ./dev/docker-compose.yml [command]`
122+
123+
Be sure to substitute `[command]` for a valid docker compose command, such as:
124+
125+
`docker compose -f ./dev/docker-compose.yml up` to build and start containers
126+
127+
OR
128+
129+
`docker compose -f ./dev/docker-compose.yml down` to stop containers
130+
115131

116132
## Release Schedule
117133

0 commit comments

Comments
 (0)