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
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,15 +8,16 @@ Out of the box, this template provides a minimal WordPress theme with basic supp
8
8
- Support for SCSS with an ITCSS structure already in place
9
9
- Support for bundling JS with `esbuild` and testing JS with `vitest`
10
10
- Support for [Twig][twig] templates using [Timber][timber]
11
-
- Database import and export scripts to make syncing between environments simple and fast
11
+
- Database/uploads import and export scripts to make syncing between environments simple and fast
12
12
- Generator scripts to speed up the process of adding:
13
13
- Page templates
14
14
- Custom post types
15
15
- Shortcodes
16
16
- Custom taxonomies
17
17
- Reusable patterns
18
+
- Custom blocks plugins
19
+
- Custom blocks
18
20
- Meta boxes
19
-
- Sample custom blocks which you can reference to create your own custom blocks
20
21
- Code style rules that are enforced by language-specific linters
21
22
- GitHub Action workflows for code quality, release management, and deployment processes
22
23
@@ -40,6 +41,8 @@ Out of the box, this template provides a minimal WordPress theme with basic supp
40
41
41
42
This project requires [Docker][docker] and [Node.js][node] for local development. For a better editing experience for PHP and Twig files, it's useful to have [PHP installed][php-install] on your system as well, but it isn't required.
42
43
44
+
If you're using Windows, it's best to use Git Bash (included when you install [Git](https://git-scm.com/downloads)) for command line operations for compatibility. If using [VS Code][vs-code], you can [set Git Bash as your default terminal](https://code.visualstudio.com/docs/sourcecontrol/intro-to-git#_git-bash-on-windows).
45
+
43
46
To run the project for the first time, do the following:
44
47
45
48
1. Duplicate `.env.example` and rename it `.env`, changing variables [as needed](#setting-local-environment-variables)
@@ -89,7 +92,7 @@ This project uses [npm scripts][npm-scripts] for most development tasks, and the
89
92
90
93
### Setting Local Environment Variables
91
94
92
-
For the local environment we are using a `.env` to define the username, passwords, and the database name used in the Docker container.
95
+
For the local environment we are using a `.env`file to define the username, passwords, and the database name used in the Docker container.
93
96
94
97
-`MYSQL_USER` is the username WordPress will use to access the database
95
98
-`MYSQL_PASSWORD` is the password for `MYSQL_USER`
@@ -182,11 +185,7 @@ You can export your `uploads` folder for another developer to import or to impor
182
185
183
186
This will happen automatically on import, but if you want to manually backup your `uploads` folder, you can run `npm run backup:uploads`. This functions nearly identically to the `export:uploads` script, except for using a different prefix and putting the zip file in `sync/uploads/backups`. As with `export:uploads`, you can specify a name for your backup if you want.
184
187
185
-
### Atom
186
-
187
-
If you use Atom, go to Preferences > Packages. Open the `language-php` Core Package settings. Go to the Tab Type setting and set the drop down option to `hard`.
188
-
189
-
#### VS Code
188
+
### VS Code
190
189
191
190
If you use [VS Code][vs-code], you can create a `settings.json` file inside a `.vscode` directory at the root of the project to change how PHP or other languages are treated by the editor.
192
191
@@ -201,7 +200,7 @@ If you use [VS Code][vs-code], you can create a `settings.json` file inside a `.
201
200
}
202
201
```
203
202
204
-
#####Helpful VS Code Extensions
203
+
#### Helpful VS Code Extensions
205
204
206
205
We recommend these extensions to make working with PHP and Twig easier.
207
206
@@ -237,7 +236,7 @@ Whenever a new version of WordPress is released, follow this process to update t
237
236
1. Change `WP_VERSION` in `Dockerfile` to the latest version
238
237
1. Submit a PR with the update
239
238
1. If your hosting provider manages the WordPress version, update it through their mechanism for staging, test, and/or production enviroments
240
-
1. If the update made breaking changes, create a bug card and _do not_ push any changes
239
+
1. If the update made breaking changes, create a bug card/issue and _do not_ push any changes
241
240
242
241
### Permalink Settings
243
242
@@ -590,7 +589,7 @@ This starter template includes a couple of options for deployment workflows, inc
590
589
591
590
### Docker deployment workflow
592
591
593
-
This repo includes a [GitHub workflow for building a docker image](./.github/workflows/deploy.docker.yml) that gets pushed GitHub's container registry. This image can be deployed to any hosting provider that supports docker containers.
592
+
This repo includes a [GitHub workflow for building a docker image](./.github/workflows/deploy.docker.yml) that gets pushed to GitHub's container registry. This image can be deployed to any hosting provider that supports docker containers.
594
593
595
594
The image includes all core WordPress files for the version specified for `WP_VERSION` in the `Dockerfile`, as well as the theme and plugin files necessary for the site. The other element required for the site to run is the database, which is excluded, since each environment should have its own database that is specified by environment variables. This allows local developers to test against local data without interfering with production or staging environments.
0 commit comments