Development Environment
Requirements
NPM for front end asset serving and bundling
Docker and Docker Compose for running the local development container
Git for version control
Instructions
Clone Directory Lister to a local repository
git clone {{ REPOSITORY_URL }}
Switch to the Directory Lister directory
cd /path/to/DirectoryLister
Install and build PHP and JavaScript dependencies
composer install npm install npm run dev
Run the local Docker container
docker-compose up -d
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 clear-cache
Build dependencies and assets (for production)
make production
Clear built assets
make clear-assets
Run test suite
make tests
Check or fix coding standards
make coding-standards
Perform static analysis
make static-analysis
Generate code coverage report
make coverage
Last updated
Was this helpful?