czernika/brocooly

WordPress Timber-based boilerplate with Bedrock structure and webpack for assets compiling

Installs: 22

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 1

Forks: 1

Open Issues: 0

Type:project

v0.26.0 2022-01-10 13:06 UTC

README

Brocooly Framework

GitHub license GitHub release Last commit PHP version BCH compliance Codacy Badge Maintainability Test Coverage Safe

WordPress starter boilerplate with an improved folder structure (by Bedrock), twig template engine and webpack for compiling assets. It uses the power of wepback and Timber together to simplify your local development workflow.

Still Beta

This package is on development mode

Requirements

  1. Composer
  2. PHP version 8.0 or greater
  3. Node.js

Getting Started

1 - Create a new project with

composer create-project czernika/brocooly your-app-folder

2 - Set your own environment variables in .env file

3 - Make sure the DocumentRoot is set to the web folder

See here.

4 - Install your project dependencies

npm install

5 - Now you can run

npm run watch

It will start watching your application at http://localhost:3000. First time this will trigger WordPress installation process

Documentation

See here. Work in progress

Known Issues

  1. During installation process you may see WordPress database error: Table doesn't exist error. It is appears as database is not set but you're already connected to it with .env file credentials.
  2. Fatal error with sqlite3 PHP module. No PHP downgrade allowed so the only option is to disable SQLite3 extension.
  3. First time login by 'wp-admin' - may not redirect to admin-panel although successfully being authenticated. If login by 'wp-login.php' - no problem.
  4. Errors within functions.php bypassing maintenance mode