Local Development & QA

Using the QuickStart Repository

The fastest and most reliable way to set up a local development environment for Drupal LMS is by using the official QuickStart repository. This repository comes pre-configured with DDEV, a powerful and easy-to-use local development tool.

The repository's README.md file contains the latest installation instructions, which are also outlined below.

DDEV Setup

To start from scratch with the quick-start repository:

1. Install DDEV: If you don't already have it, install DDEV by following the official installation instructions.
     
2. Start DDEV: Navigate to the cloned repository folder in your terminal and run ddev start — choose Drupal 11 for the project, or change Drupal version in composer.json.  DDEV will automatically configure a web server, database, and other services.
     
3. Install Dependencies: Run ddev composer install to download Drupal core and all required modules.
     
4. Install Drupal LMS: You can install the site using one of the following commands:
   • ddev composer si: Installs a minimal Drupal site with the full LMS configuration enabled. Ideal for a clean start.
       
   • ddev composer sid: Installs the site with additional sample content (test users, courses, lessons, and activities). This is highly recommended for development and testing.
       
   • ddev composer test-environment: Installs a minimal Drupal site configured specifically for running functional JavaScript tests.
       
5. Log In: If you used ddev composer sid, you can log in with one of the default user accounts: LMS Student, LMS Teacher, or LMS Admin.  They all have the password: 123456.  A password for the User 1 admin account will also be provided in the terminal output.
     

Testing and Quality Assurance

The quick-start repository is configured to make testing and QA straightforward.

Running Automated Tests

The module includes a suite of automated tests, which will help you ensure that any code changes you've made haven't affected the module's expected function. To run them, you can use the built-in Composer scripts from your project directory:

1. Connect to the DDEV container's shell: ddev ssh
     
2. If you're running tests in this project for the first time, create a browser_output directory:
   mkdir web/sites/default/files/simpletest/browser_output
     
3. Run the Functional JavaScript tests for the module:
   composer test lms
     

The tests will report any issues, so you can update your code and re-test.  If the tests fail, it can be helpful to view the last file in the browser_output directory, which may give you some clues about what went wrong.

Code Style and Analysis

To ensure code quality, you can run the following analysis tools from your project directory:

• PHPStan (Static Analysis):
  ddev composer phpstan lms
    
• PHP CodeSniffer (Coding Standards):
  ddev composer phpcs lms