Thanks to everyone who has starred my repo! If you like this project, please consider giving it a star.

WPacked

WPacked aims to provide an easy-to-maintain and deployable development starter kit, within a clean pure local environment. Just like you usually do with npm.

No more XAMP/MAMP or virtual machines, or other (often conflicting) software on your local machines. You just need PHP.

Clean, versionable, quick.

Breaking Change Announcement: Dropping SQLite Support

After careful consideration and thorough evaluation, we've decided to drop the SQLite support. The reasons behind this change:

Development stall: The plugin enabling SQLite support in WordPress is no longer actively maintained. As a community that values security, stability, and cutting-edge practices, depending on stalled plugins should go against our principles.
No significant advantage for quickstart: One of the main reasons for initially including SQLite support was to enable users to quickly set up a new WordPress project. However, with the advent and widespread adoption of Docker, creating a robust local stack has become a matter of seconds. Docker not only simplifies the setup process but also provides a more realistic environment that mirrors production setups.

Heroku/Dokku ready

This project will be automatically built and ready to go just pushing the repository itself to Heroku or Heroku-like environments like Dokku. It will be ran under nginx (slightly optimized with gzip and assets caching).

Background

I really enjoy developing using the Node.js ecosystem. I love to make my projects modular with npm and bower, I adore the easy dependency management. The thing I like the most is that I can start working immediately on my local machine without a full-fledged web server.

Of course there are tools that give you quickly(sh) a development server within your machine, (I'm personally a big fan of roots/bedrock, that inspired this project) but all of them need a Vagrant virtual machine. Quite an overkill for most projects.

I also like the idea of just dropping a project on a webserver when I'm done (almost impossible with MySQL).

I tried to create a lovely and easy development flow with my favorite CMS, so here we are: my attempt to make WordPress as a self contained, packaged application as possible. Hope you enjoy it ;)

Slideshare presentation

Checkout the presentation published during August Wordpress Meetup in Rome http://www.slideshare.net/EnricoDeleo/modern-gentlemens-wordpress

Key features

Git-friendly
Dependency management via Composer
Containerizable

Requirements

A Unix-like OS
PHP >= 7.4
Composer
MySQL/MariDB

Requirements installation

OS X

The best way to manage packages and installations on your Mac is Homebrew. If you haven't it yet, well you should. Follow the instructions on the Homebrew's official website.

Suggested to update homebrew to the latest version

$ brew update && brew upgrade

Then install the php version of your choice with

$ brew install php

You'll need also Composer, so let install it:

brew install composer

For a local database:

brew install mariadb

Optional

Optional but suggested wp-cli. It'll speed up several operations giving you the possibility to issue commands to WordPress via terminal. This repo has a wp-cli.yml that automatically will point wp-cli to the actual wordpress directory, you just need to use the wp command inside the project directory.

brew install wp-cli

Linux

todo, feel free to make a pull request -

Usage

The goal of this project is instant development. It requires just two commands.

Clone this repo and run

composer install

in order to install all the dependencies of the project.

You are already done, just launch the built-in web server with

composer run serve --timeout=0

and visit the default location http://127.0.0.1:8000 🚀

Adding WordPress plugins

In a proper composer/git-driven workflow you want to add 3rd parties plugins via composer. You can find all the free plugins available in the WP ecosystem on WordPress Packagist.

Example of plugin installation (digit in your shell):

composer require "wpackagist-plugin/jetpack":"8.5"

WP Configuration

Thanks to phpdotenv you can store your configurations outside the public directory in a .env file. You'll find the file .env.example that you need to copy to .env within the root directory of the project with the following variables:

variable name	role
ENVIRNOMENT	the environment where the app lives in (development, staging, production)
WP_HOME	the url of the website
WP_SITEURL	the url of the wordpress directory, here is urlofthesite.ltd/wordpress
DB_NAME	name of the MySQL DB
DB_USER	user of the MySQL DB
DB_PASSWORD	password of the MySQL DB
DB_HOST	host of the MySQL DB
FORCE_SSL	`1` in order to force SSL (redirects all requests to https://)
DISABLE_WP_CRON	whether or not the app should use the WP cron system (false requires setting up cron manually on your server)

For security purposes, don't forget to set AUTH_KEY, SECURE_AUTH_KEY, LOGGED_IN_KEY, NONCE_KEY, AUTH_SALT, SECURE_AUTH_SALT, LOGGED_IN_SALT, NONCE_SALT to different (long) random strings on production.

NOTE Don't commit the .env file, it's very likely that you want sapearate settings for each copy of the project. e.g. different URLs for each environment like website.dev, staging.website.com and website.com. Just set those domains on each respective .env and you're ready to go :)

Development custom php.ini

You can customize all php configurations without touching your default/system's php.ini while using the built-in web server.

Just edit the ./php-server.ini file under the [ini] section.

Deploy ⚡

You can just upload it to your server and point the webserver of your choice to /path/to/project/app or build and deploy your docker image.

How to add WordPress Plugins

All PHP dependencies are managed by Composer, the same happens for WordPress plugins (of course if they are commodities and not custom ones). You can find all the packagist entries for WordPress plugins on the WPackagist official website.

For example, searching for buddypress would return something like "wpackagist-plugin/buddypress":"4.2.0", you just need to drop this line inside the composer.json's require section and type

composer update

The whole plugins directory is under .gitignore, so if you add custom plugins you need to exclude them (you'll find an example within the .gitignore file) and add them to Git.

Docker 🆕

A docker file and docker-compose are now included for building and local development with MariaDB and Nginx included.

Local development

Run docker compose up in order to bring up the entire local stack. It will start all the containers needed for a great experience. The same docker-compose could also be seen as a starting point for your production configuration if you're using e.g. docker swarm.

The local development stack features:

A WordPress container powered by PHP 8, Nginx, Composer
MariaDB
Adminer for database operations through the browser
An nginx reverse proxy so that you can access your new website via domain not localhost

Thanks to the reverse proxy you'll access the website at http://wordpress.local and adminer at http://adminer.local.

Accessing local domains

You need to add these lines in your hosts file:

127.0.0.1 wordpress.local
127.0.0.1 adminer.local

Run commands inside the Wordpress container

docker compose run --rm wordpress /bin/sh

Building

From the root of this project, run docker build . in order to build a docker image.

Author

Enrico Deleo

Are you looking for a modern super-developer-oriented starter theme?

Look no further, try my Vueird starter theme powered by WebPack, Vue, SCSS

enricodeleo / wpacked Goto Github PK

wpacked's Introduction