UX-SAD Visualization Frontend

Preface

This README file is written in OrgMode. As such, all the provided commands use paths relative to the directory of this file to allow the execution of the code blocks directly (in GNU Emacs, using C-c C-c).

Developing

Installing the Dependencies

The development relies on Docker and Laravel Sail. To install Docker, use your preferred installation method. Then run the following commands in the repository’s directory to install all the required dependencies.

# Install PHP depencies
docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v $(pwd):/opt \
    -w /opt \
    laravelsail/php74-composer:latest \
    composer install --ignore-platform-reqs
# Publish docker-compose.yml to the root of the repository
./vendor/bin/sail artisan sail:install
# Install JS dependencies
./vendor/bin/sail npm install

Starting the Application

On Linux, we can start the service and all its requirements using Laravel Sail. The application will then be available at http://localhost

./vendor/bin/sail up -d

Stopping the Application

To stop the background processes and the application, it suffices to run the following command.

./vendor/bin/sail down