CREATE AND RUN A WORDPRESS INSTANCE LOCALLY WITHIN 8 SECONDS!
WPLOCAL is a command-line tool for creating and managing very fast local WordPress installations. You can create an instante in merely 8 seconds with its dedicated folder and database, without using any complicated or cumbersome platform such as Docker or Vagrant. Instead, it uses Laravel Valet (which uses Caddy and DNSMasq), MariaDB, the mighty wp-cli and PHP7 libraries all through composer and brew package managers.
For the latest news on this project, follow @hellodevapps on Twitter, me @schmitzoide on Twitter or visit my blog. There will be a roadmap soon here for an overview of what's planned for upcoming releases, and also with directions on how to contribute to this project and where to work on first. THERE'S A LOT TO DO! For now, I just want to test this out and get a grip of how it is working as a basic simple and very useful tool and take it to higher levels such us remote instance replications, cloning, local sharing, automatic publications and more.
All this comes out of our daily working day at hellodev, a WordPress specialised agency from Porto, Portugal, as a contribution to the community.
WPLOCAL goal is to provide a command-line interface for creating a local WordPress installation with one simple line: wplocal create -w mysite. This will create a folder named mysite, and in it, the latest WordPress release with a database called mysite, and a running site at http://mysite.test.
$ wplocal create -w mysite
Going to install WordPress on folder /Users/marcelschmitz/Documents/Websites/mysite accessible at http://mysite.test...
Creating folder...
Installing WordPress here...
Downloading WordPress 4.9.7 (en_US)...
Using cached file '/Users/marcelschmitz/.wp-cli/cache/core/wordpress-4.9.7-en_US.tar.gz'...
Success: WordPress downloaded.
✔︎ Done
Creating database...
Starting MySQL
.161129 23:44:48 mysqld_safe Logging to '/usr/local/var/mysql/Marcels-iMac.local.err'.
SUCCESS!
✔︎ Done
Configuring WordPress...
Success: Generated 'wp-config.php' file.
Starting Valet...
A [mysite] symbolic link has been created in [/Users/marcelschmitz/.valet/Sites/mysite].
✔︎ All Done!
✔︎ InstalledThis created the above install in 8 seconds! You can very quickly undo this, delete everything created by the command line with this simple command:
$ wplocal destroy -w mysite
Going to uninstall website on folder /Users/marcelschmitz/Documents/Websites/mysite and delete the database. Proceed? (y)es / (n)o
y
Deleting database...
Starting MySQL
SUCCESS!
✔︎ Done
Deleting folder...
161129 23:46:32 mysqld_safe Logging to '/usr/local/var/mysql/Marcels-iMac.local.err'.
✔︎ DoneThis took 1 second to complete. It is really just that simple.
To install this command-line tool you'll need to download the complete project and run the install script.
Minimum requirements are an OS X operating system, 10.8 or greater. Sorry, no Linux or UNIX support yet. More on that later!
When you're ready you can download the complete project into a folder and lauch the terminal inside that folder. Then you need to do this simple lines of commands:
$ chmod +x install.sh
$ ./install.shIf it all went ok (no reason not to), the script will automatically execute wplocal version and expect something like this to come out:
v0.2 by Marcel Schmitz @schmitzoide hellodev.us
ALL DONE!As a final step, you need to install all the components that WPLOCAL needs to run. Well, you just need to type a command, WPLOCAL will do all the dirty work for you:
$ wplocal setup
Going to check for installed compoments...
## Checking for 🍺 Brew
Homebrew 1.7.1
Homebrew/homebrew-core (git revision 92d57; last commit 2018-08-01)
✔︎ Check
Update available?
Already up-to-date.
## Checking for Composer
Composer version 1.5.2 2017-09-11 16:59:25
✔︎ Check
## Checking for MySQL
mysql Ver 15.1 Distrib 10.2.10-MariaDB, for osx10.13 (x86_64) using readline 5.1
✔︎ Check
## Checking for Laravel Valet
Password:
Laravel Valet 2.0.12
✔︎ Check
## Checking for WP-CLI
WP-CLI 1.5.1
✔︎ Check
## Updating everything to the latest version
Changed current directory to /Users/marcelschmitz/.composer
Loading composer repositories with package information
Updating dependencies (including require-dev)
Nothing to install or update
Generating autoload files
✔︎ Check
## Checking for dependencies
Going to install...
GEM dependencies...
✔︎ Installed
Pinging .test...
PING *.test (127.0.0.1): 56 data bytes
64 bytes from 127.0.0.1: icmp_seq=0 ttl=64 time=0.036 ms
--- *.test ping statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 0.036/0.036/0.036/0.000 ms
✔︎ ALL GOOD! Hurray!
CD into the dir where you want to install your local WordPress website and run `wplocal create -w NAME_OF_SITE`Well, this is probably the first thing to do if you want to contribute, build the update command. Shouldn't be difficult, right? Want to do it? Otherwise, repeat the install process with the newest release.
To checkout what else WPLOCAL can do (not that much yet), just type wplocaland hit ENTER.
This is our first project on Github, open to the public, embracing all kinds of contributions to make this project get somewhere. Therefore, it is with a great pleasure that I invite YOU dearly to contribute! We need your support! Not only to write code, but also to test it and criticise and suggest new features and break it for us to fix it.
This is yours! This is ours!
All the libraries used for this tool to work are done by a tone of awesome, out of the world, developers which contribution is why we exist today as developers that we are. The only thing we've done (actually, Marcel did it) is to code the wplocal.rb which we hope we can expand and start adding some names here. So for now, we thank your CTO for making our lives a tiny bit easier: