installing.md

Installing for Development

Requirements

In order to build and develop LifterLMS locally, you'll need the following:

• PHP
• MySQL / MariaDB
• Composer
• Node.js
• npm

Building LifterLMS

1. Clone source from GitHub

$ git clone https://github.com/gocodebox/lifterlms
$ cd lifterlms

If you're planning to contribute code, you should fork this repository and clone your fork instead and switch to the dev branch before continuing the install.

$ git checkout dev

2. Install composer dependencies:

$ composer install

3. Install npm dependencies:

$ npm install --global gulp
$ npm install

4. Build static assets

$ npm run build

The lifterlms directory is now an installable plugin that can be moved into your local server's wp-content/plugins directory.

Running PHPCS

When contributing you should ensure your contributions follow our coding and documentation standards.

To check for errors and warnings in your code, run PHPCS:

$ composer run check-cs

To check for errors only:

$ composer run check-cs-errors

These reports may include issues that can be automatically fixed using PHPCBF:

$ composer run fix-cs

Running Test Suites

New code should also strive to be covered by automated tests.

LifterLMS has unit and integration tests via phpunit and End-to-End tests via Jest and Puppeteer.

For guides on running and contributing tests, see the relevant guides:

• phpunit
• e2e