Development Environment

Requirements

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. Clone your fork to a local repository

    git clone {{ YOUR_REPOSITORY_URL }}
  2. Switch to the Directory Lister directory

    cd /path/to/DirectoryLister
  3. Install and build PHP and JavaScript dependencies

    composer install
    npm install && npm run dev
  4. Create the Docker development network

    docker network create development
  5. Create the Docker development proxy

    docker run -d -p 80:80 --network development --restart unless-stopped --volume /var/run/docker.sock:/tmp/docker.sock:ro --name dev-proxy jwilder/nginx-proxy
  6. Add the following entry to /etc/hosts:

    127.0.0.1 directory-lister.local
  7. 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