Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit 8f0cdbb

Browse files
authored
Better intro
1 parent 69d9806 commit 8f0cdbb

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
1-
This repo contains a "VVV" Vagrant / VirtualBox based local development environment setup for jkl.hacklab.fi site.
2-
3-
It supports GIT based theme and plugin development workflow using popular PHP/WP development tools:
1+
This repo contains a "VVV" Vagrant / VirtualBox based local development environment setup for jkl.hacklab.fi site. It supports modern theme and plugin development workflow with popular PHP/WP development tools set up on a regular LEMP stack on Ubuntu:
42

53
- PHP error logs at `www/hacklab-jkl/wp-content/debug.log`
64
- [WP-CLI](https://make.wordpress.org/cli/handbook/guides/quick-start/) tool
7-
- PhpMyAdmin and readiness to [connect external SQL clients](https://varyingvagrantvagrants.org/docs/en-US/references/sql-client/) like DBeaver etc.
5+
- PhpMyAdmin and readiness to [connect external SQL clients](https://varyingvagrantvagrants.org/docs/en-US/references/sql-client/) like DBeaver CE etc.
86
- IDE features
97
- LSP (go-to-declaration etc. just start editor in www-root),
108
- XDebug (see notes on later section for config)
119
- Profiling tools, mail diagnostics, etc...
1210
- Automatic hosts file config for development domain, access via http://jkl.hacklab.test
1311
- Composer etc.
1412

15-
It works on computers with X86/AMD64 CPU. Apple Silicon Mac users would need to use commercial version of Parallels to be able to run this (YMMV) or use something else like [Docker based WP-ENV](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/) or [LocalWP app](https://localwp.com/). The basic sync script `pull-production.sh` written in bash could also be useful as a starting point with other development environment setups.
13+
VVV is long running project and has nearly everything required for development while it can seem a bit heavy and monolithic (and more tied to AMD64). It's still a very active open source project with developers keeping it up to date and responding to guestions in support channels.
14+
15+
Other development environment tools can be leveraged also with some minor changes in the `pull-production.sh` sync script written to be run in VVV root path.
16+
17+
Apple Silicon Mac would need to use commercial version of Parallels to be able to run Vagrant. Better options may be to run Vagrant on a separate AMD64 laptop or to use [LocalWP app](https://localwp.com/) with modified sync script. Container based [WP-ENV](https://developer.wordpress.org/block-editor/getting-started/devenv/get-started-with-wp-env/) tool and plain container images are available also.
1618

1719
## Setup with existing VVV environment
1820
Add to config.yml:

0 commit comments

Comments
 (0)