Development Environment

Requirements

• PHP >= 7.4

  • Composer

• NPM

• Docker

  • Docker Compose

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

2. Clone your fork to a local repository

   git clone {{ YOUR_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. Add the following entry to /etc/hosts:

   127.0.0.1  directory-lister.local

6. Run the local Docker container

   docker-compose up -d

You should now be able to access your local Directory Lister installation at http://directory-lister.local