Merge pull request #203 from creativecommons/baseline_docker_compose

Setup baseline docker-compose.yml configuration with Apache web server, latest WordPress, with a mySQL db

Author: possumbilities

.gitignore

@@ -56,4 +56,8 @@ tramp
 .DS_Store
 
 # JavaScript / Gutenberg development
-node_modules/
+node_modules/
+
+# Docker Dev
+/dev/db
+/dev/wordpress

README.md

@@ -112,6 +112,35 @@ At a glance, with WP CC Plugin you can:
 Contributions will be very appreciated. See
 [`CONTRIBUTING.md`](CONTRIBUTING.md).
 
+### Using a localized Docker Setup
+
+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.
+
+It is modelled after the official example, given here by WordPress: https://hub.docker.com/_/wordpress/
+
+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.
+
+`docker compose -f ./dev/docker-compose.yml [command]`
+
+Be sure to substitute `[command]` for a valid docker compose command, such as: 
+
+`docker compose -f ./dev/docker-compose.yml up` to build and start containers
+
+OR
+
+`docker compose -f ./dev/docker-compose.yml down` to stop containers
+
+The first time the build process is run via `docker compose -f ./dev/docker-compose.yml up`, docker will create two directories within your local repository clone:
+
+- `./dev/db` where the database and relevant config will be stored
+- `./dev/wordpress` where the WordPress files will be stored
+
+It will then mount this plugin's root directory into the `/wp-content/plugins/` directory of the WordPress installation. Edits made to your local plugin clone will reflect within the build.
+
+You can then navigate to `http://localhost:8080/` and proceed with a manual WordPress installation. After the initial installation the WordPress install will persisist between docker sessions. 
+
+If you need to reset the WordPress install to a "clean slate" you can simply delete the `db` and `wordpress` directories respectively, and then run `docker compose -f ./dev/docker-compose.yml up` again to initialize a clean install build. 
+
 
 ## Release Schedule
 

dev/docker-compose.yml

@@ -0,0 +1,34 @@
+version: '3.2'
+services:
+  wordpress:
+    container_name: 'local-wordpress'
+    image: wordpress
+    restart: always
+    links:
+      - db:mysql
+    ports:
+      - "8080:80"
+    environment:
+      WORDPRESS_DB_HOST: db:3306
+      WORDPRESS_DB_USER: root
+      WORDPRESS_DB_PASSWORD: root
+      WORDPRESS_USER: root
+      WORDPRESS_DB_name: wordpress
+    depends_on:
+      - db
+    volumes:
+      - ./wordpress:/var/www/html
+      - ../.:/var/www/html/wp-content/plugins/wp-plugin-creativecommons
+      # Ignore these directories when mounting the root into /var/www/html/wp-content/plugins/wp-plugin-creativecommons so they are not included
+      - /var/www/html/wp-content/plugins/wp-plugin-creativecommons/dev/wordpress
+      - /var/www/html/wp-content/plugins/wp-plugin-creativecommons/dev/db
+  db:
+    container_name: 'local-wordpress-db'
+    image: mariadb
+    restart: always
+    environment:
+      MYSQL_DATABASE: wordpress
+      MYSQL_USER: root
+      MYSQL_ROOT_PASSWORD: root
+    volumes:
+      - ./db:/var/lib/mysql