Skip to content

Latest commit

 

History

History
87 lines (48 loc) · 3.76 KB

README.md

File metadata and controls

87 lines (48 loc) · 3.76 KB
Raw

LifterLMS

WordPress plugin WordPress WordPress rating WordPress Build Status Code Climate Test Coverage

LifterLMS, the #1 WordPress LMS solution, makes it easy to create, sell, and protect engaging online courses.

Changelog

Documentation

Getting Help and Support Support

GitHub is for bug reports and contributions only! If you have a support question or a request for a customization this is not the right place to post it. Please refer to LifterLMS Support or the community forums. If you're looking for help customizing LifterLMS, please consider hiring a LifterLMS Expert.

Reporting a Bug

Bugs can be reported at https://github.com/gocodebox/lifterlms/issues/new.

Before reporting a bug, search existing issues and ensure you're not creating a duplicate. If the issue already exists you can add your information to the existing report.

Also check our known issues and conflicts for possible resolutions.

Contributing contributions welcome

Interested in contributing to LifterLMS? We'd love to have your contributions. Read our contributor's guidelines here.

Installing for Production Usage

If you clone or download this repo directly it will not run as a plugin inside WordPress! Installable production releases are available in on the Releases tab. You can get the latest stable release from WordPress.org

Installing for Development

  1. Composer
  • curl -sS https://getcomposer.org/installer | php
  • php composer.phar install
  1. Node
  • Install node
  • Install npm
  • npm install --global gulp
  • npm install

Coding Standards

For standards we're working off a modified version of the WordPress Coding Standards.

We're utilizing (a currently slightly modified version of) the WordPress Coding Standards Core Ruleset for PHPCS (php codesniffing).

Our javascript and SCSS are a mess. We're tackling that next.

Running phpcs

Use the shorthand composer script to run phpcs against all PHP files.

  • composer run-script phpcs

Alternatively access the executable:

  • ./vendor/bin/phpcs path/to/file.php

To see errors only (no warnings):

  • ./vendor/bin/phpcs -n path/to/file.php

To see all options:

  • ./vendor/bin/phpcs -h

Running phpcbf

  • ./vendor/bin/phpcbf to run on all php files
  • ./vendor/bin/phpcbf path/to/file.php to run on a specific file