Skip to content
No description, website, or topics provided.
PHP JavaScript Shell
Branch: dev
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows Merge branch 'head-tags' into add-phpcs-github-action Dec 18, 2019
bin test(head-tags): add the first unit tests Dec 1, 2019
plugins Small improvements to the readme Jan 15, 2020
scripts Fix build script Dec 19, 2019
shared Use the correct filename when de/activation Dec 20, 2019
.gitignore Add build folder to gitignore Dec 16, 2019 Improve MySQL and Xdebug installation instructions Dec 16, 2019
babel.config.js wires up js for the different plugins Jun 27, 2019
composer.json test(phpunit): downgrade to phpunit 7 Dec 1, 2019
package.json Add npm script to release a new version Dec 16, 2019
phpcs.xml Remove deprecated TimezoneChange rule Dec 19, 2019
webpack.config.js Rename entries in webpack config Dec 18, 2019

Frontity WP Plugins

How to collaborate

1. Fork this repo to your GitHub account.

2. Clone the fork in your computer.

3. Add the plugins to your WordPress installation.

You can add them using symlinks:

npm run sync ../../path/to/your/wordpress

If you work with Local by Flywheel you have to use their addon Volumes to add the plugins to the WordPress.

4. Make the modifications to the code.

5. Submit a Pull Request.

WordPress Code Standards and Unit Tests

Installation in macOS

1. Install PHP.

Our recommendation is to use Homebrew:

brew install php

2. Install Composer.

Our recommendation is to use Hombrew:

brew install composer

Then, install the dependencies:

composer install

3. Install MySQL (for unit tests only)

Our recommendation is to use DBngin.

Once you've installed DBngin, create a new MySQL database (v5.7) and click on "Start".

Then, click on the terminal icon and add the line it shows to your .bash_profile or .zshrc file:

# DBngin exports
export PATH=/Users/Shared/DBngin/mysql/5.7.23/bin:$PATH

Change 5.7.23 for your MySQL version.

4. Install Xdebug (for debugging of unit tests)

Our recommendation is to use pecl:

pecl install xdebug

After the installation, add an extension with the Xdebug configuration at /usr/local/etc/php/7.X/conf.d/ext-xdebug.ini:


Change 7.X for your PHP version and YYYYYY for the folder where pecl installed Xdebug.

You may need to clean your previous PHP installation first, then install it again with brew. This post explains the process. You can skip the Nginx section.

You may need to remove the first line that the pecl installation added to your php.ini file at /usr/local/etc/php/7.X/php.ini.

Run the code standards and beautifier

You can use these two commands to check that your code meets the WordPress standards:

npm run phpcs
npm run phpcbf

Run the unit tests

The first time, you need to install the database and download WordPress

npm run install-wp-tests

This will run bin/ with the following parameters:

  • DB_NAME=frontity-tests
  • DB_USER=root
  • DB_PASS='' (blank)
  • DB_HOST=localhost
  • WP_VERSION=latest
  • SKIP_DB_CREATE=false

You can also run it manually if you prefer.

Then, use npm run phpunit to run the tests.

You can’t perform that action at this time.