You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,24 +7,30 @@ This installation script automatically sets up a development Docker server with
7
7
_Note: [DDEV](https://ddev.com/) needs to be installed in order for the installation script to work._
8
8
9
9
1. Clone this [repo](https://github.com/jacobcassidy/ddev-wp-setup-script) to your (preferably empty) project's root directory with the command: **`git clone [email protected]:jacobcassidy/ddev-wp-setup-script.git`**
10
-
2. Customize the configuration settings in: _ddev-wp-setup-script/config.sh_
10
+
2. Customize the script's configuration settings at: _ddev-wp-setup-script/settings.sh_
11
11
3. Run the installation script in you project's root directory with the command: **`ddev-wp-setup-script/install.sh`**
12
12
4. Delete the _ddev-wp-setup-script_ directory after successfully running the installation script
13
13
14
14
## Features
15
15
16
+
> [!NOTE]
17
+
> The optional features can be turned on/off in the `settings.sh` file.
18
+
16
19
This script automatically sets up the following:
17
20
18
21
- Configures and starts the [DDEV](https://ddev.com/) Docker containers with a WordPress development server.
19
22
- Installs a clean WordPress site with the default pages, posts, comments, plugins, themes, welcome panel and dashboard widgets removed (with the exception of the latest official default theme as a fallback).
20
-
- Downloads, installs, and activates the [CassidyWP Starter Block Theme](https://github.com/jacobcassidy/cassidywp-starter-block-theme).
21
-
- Installs the [All-in-One WP Migration plugin](https://wordpress.org/plugins/all-in-one-wp-migration/).
22
-
- Installs the [All-in-One WP Migration Unlimited Extension plugin](https://servmask.com/products/unlimited-extension).
23
-
-_Note: this plugin is not free and is sourced from your local machine since it's unavailable through the official WP plugin directory. If you don't have this plugin, you can turn the installation off in the `config.sh` file by setting `INSTALL_LOCAL_AIOMUE_PLUGIN` to false._
24
-
- Installs the [Query Monitor plugin](https://wordpress.org/plugins/query-monitor/).
25
-
- Installs the files needed to connect the DDEV Docker containers with the [Spatie Ray](https://myray.app/) desktop app (used for simple debugging when Xdebug is overkill).
26
-
- Initializes a local project Git repo and adds a `.gitignore` file configured for WordPress.
27
-
- Adds a VSCode Workspace `.vscode/settings.json` file to include formatting rules to match WordPress's official coding standards.
23
+
- (Optional) Downloads, installs, and activates the [CassidyWP Starter Block Theme](https://github.com/jacobcassidy/cassidywp-starter-block-theme).
24
+
- (Optional) Installs the [All-in-One WP Migration plugin](https://wordpress.org/plugins/all-in-one-wp-migration/).
25
+
- (Optional) Installs the [All-in-One WP Migration Unlimited Extension plugin](https://servmask.com/products/unlimited-extension).
26
+
-_The setup for this plugin is set to `false` by default since it's a paid plugin and is installed from your local machine. If you have this plugin, you can turn the installation on in the `settings.sh` file by changing `INSTALL_LOCAL_AIOMUE_PLUGIN` to `true` and updating the path to your zip file._
27
+
- (Optional) Installs the [Query Monitor plugin](https://wordpress.org/plugins/query-monitor/).
28
+
- (Optional) Installs the files needed to connect the DDEV Docker containers with the [Spatie Ray](https://myray.app/) desktop app (used for simple debugging when Xdebug is overkill).
29
+
- (Optional) Initializes a local project Git repo and adds a `.gitignore` file configured for WordPress.
30
+
31
+
## Configuration files for development
32
+
33
+
Originally, this script contained development configuration files such as `prettier.config.js` and `eslint.config.js`. Those configuration files have been moved to their own repo at [wp-dev-config-files](https://github.com/jacobcassidy/wp-dev-config-files) and can be cloned from there.
0 commit comments