Contributing

Requirements

Getting started

  1. Clone the repository using git clone https://github.com/stephanzwicknagl/viasp.git

  2. Create and activate a conda environment

  3. Install pip conda install pip

  4. Install viASP in editable mode pip install -e viasp -e viasp/backend -e viasp/frontend

Developing the backend

  1. Simply edit the code in the backend folder viasp/backend/src

  2. Run viASP with a clingo program viasp encoding.lp

Developing the frontend

  1. Move to frontend folder cd viasp/frontend

  2. Run npm i to install all needed dependencies

  3. Run npm run start to continuously pack the javascript

  4. Run a modified viASP App to see changes on the frontend immediately python DevApp.py 0 encoding.lp

Note

The JavaScript and CSS files are located at /frontend/src/lib. The frontend code needs to be packed before changes become visible to the webpage.

Code your heart out!