Development Environment

Requirements

• PHP >= 8.2 with the zip, dom and fileinfo (and optionally apcu, memcached, redis) extensions

  • Composer for PHP dependency management

• NPM for front end asset serving and bundling

• Docker and Docker Compose for running the local development container

• Git for version control

Instructions

These instructions are for setting up a local DEVELOPMENT environment. If you are looking for basic installation instruction see the Installation page instead.

1. Fork the Directory Lister repository to your own account (optional)

2. Clone Directory Lister to a local repository

   git clone {{ REPOSITORY_URL }}

3. Switch to the Directory Lister directory

   cd /path/to/DirectoryLister

4. Install and build PHP and JavaScript dependencies

   composer install
   npm install
   npm run dev

5. Run the local Docker container

   docker-compose up -d

6. Add a host name entry to /etc/hosts (optional)

   127.0.0.1  directory-lister.local

You should now be able to access your local Directory Lister installation at http://localhost (or http://directory-lister.local if you added a host name entry)

Common Development Commands

Many common development actions have been defined in the Makefile and can be run with make command.

Clear the application cache

Make

make clear-cache

Manual

Build dependencies and assets (for production)

Make

make production

Manual

Clear built assets

Make

make clear-assets

Manual

Run test suite

Make

make tests

Composer

Manual

Check or fix coding standards

Make

make coding-standards

This will apply coding standard fixes will be automatically. See the Compor or Manual tab to report coding standard problems without modifying files.

Composer

Manual

Perform static analysis

Make

make static-analysis

Composer

Manual

Generate code coverage report

First Tab

make coverage

Composer

Untitled

Code coverage requires a code coverage engine (e.g. xdebug pr pcov) to run.