feat: add example theme with carbon fields and front-end structure

Front-end includes typescript, tailwind, eslint and prettier.

Author: joaquimds

.env.example

@@ -1,25 +1,19 @@
-# ${WORDPRESS_DB_NAME} and ${WORDPRESS_DB_PASSWORD} are passed from the environment variables
-# Docker Compose adds when the `wordpress` container is launched
-# In a production environment we should set them directly
-DB_NAME=${WORDPRESS_DB_NAME}
+DB_NAME=wordpress-starter-template
 DB_USER=root
-DB_PASSWORD=${WORDPRESS_DB_PASSWORD}
+DB_PASSWORD=password
 
 # Optionally, you can use a data source name (DSN)
 # When using a DSN, you can remove the DB_NAME, DB_USER, DB_PASSWORD, and DB_HOST variables
 # DATABASE_URL='mysql://database_user:database_password@database_host:database_port/database_name'
 
-# ${WORDPRESS_DB_HOST} and ${WORDPRESS_TABLE_PREFIX} are passed from the environment variables
-# Docker Compose adds when the `wordpress` container is launched
-# In a production environment we should set them directly
-DB_HOST=${WORDPRESS_DB_HOST}
-DB_PREFIX=${WORDPRESS_TABLE_PREFIX}
+DB_HOST=mysql
+DB_PREFIX=wp_
 
 # Make sure that WP_HOME url does not have a trailing slash after it
 WP_ENV='development'
 WP_HOME='http://localhost:8082'
 WP_SITEURL="${WP_HOME}/wp"
-WP_DEBUG_LOG=/path/to/debug.log
+WP_DEBUG_LOG=/var/www/html/web/app/debug.log
 
 # Generate your keys here: https://roots.io/salts.html
 AUTH_KEY='generateme'

.gitignore

@@ -21,6 +21,7 @@ web/.htaccess
 
 # Composer
 /vendor
+/web/app/vendor
 
 # WP-CLI
 wp-cli.local.yml

README.md

@@ -11,7 +11,8 @@ This folder structure uses the [Bedrock](https://roots.io/bedrock/) pattern, a m
 
 ## Run locally
 
-1. [Generate a repository](https://github.com/commonknowledge/groundwork-starter-template/generate) from this template
+1. [Clone This Repository](https://github.com/commonknowledge/wordpress-starter-template)
+2. Search and replace all instances of `wordpress-starter-template` and `WordpressStarterTemplate` with the name of the new project, in kebab and camel case respectfully. Also rename the theme folder `web/app/themes/wordpress-starter-template` to the name of the new project.
 2. If you have PHP and Composer installed locally you can run from this directory `composer install`. Otherwise run `composer install` via Docker with `docker compose run composer install`.
 3. Copy `.env.example` to `.env`, running `cp .env.example .env`. The example file contains variables required for this Docker Compose setup but modify details appropriately [as per the Bedrock documentation](https://roots.io/bedrock/docs/environment-variables/) as required.
 4. Start up all containers with:

composer.json

@@ -25,23 +25,31 @@
     "roots/wp-password-bcrypt": "1.1.0",
     "wpackagist-plugin/wordpress-importer": "^0.8.0",
     "wpackagist-plugin/wordfence": "^8.0",
-    "wpackagist-plugin/safe-svg": "^2.1.1"
+    "wpackagist-plugin/safe-svg": "^2.1.1",
+    "htmlburger/carbon-fields": "^3.6"
   },
   "require-dev": {
     "squizlabs/php_codesniffer": "^3.7.2",
     "roave/security-advisories": "dev-latest",
     "smgladkovskiy/phpcs-git-pre-commit": "dev-master",
-    "wpackagist-plugin/create-block-theme": "2.4.0",
+    "wpackagist-plugin/create-block-theme": "^2.6.0",
     "wpackagist-plugin/pattern-manager": "^0.3.0",
     "wpackagist-plugin/duplicate-post": "^4.5",
-    "wpackagist-plugin/fakerpress": "^0.6.1"
+    "wpackagist-plugin/fakerpress": "^0.6.1",
+    "mnsami/composer-custom-directory-installer": "^2.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "CommonKnowledge\\WordpressStarterTemplate\\": "web/app/themes/wordpress-starter-template/src/"
+    }
   },
   "config": {
     "optimize-autoloader": true,
     "preferred-install": "dist",
     "allow-plugins": {
       "composer/installers": true,
-      "roots/wordpress-core-installer": true
+      "roots/wordpress-core-installer": true,
+      "mnsami/composer-custom-directory-installer": true
     }
   },
   "minimum-stability": "dev",
@@ -56,6 +64,9 @@
       ],
       "web/app/themes/{$name}/": [
         "type:wordpress-theme"
+      ],
+      "web/app/vendor/{$vendor}/{$name}/": [
+        "htmlburger/carbon-fields"
       ]
     },
     "wordpress-install-dir": "web/wp"