Get started¶

Run local cluster¶

Make sure you install docker first. Get started with Docker

tl;dr

git clone https://github.com/khaxis/plynx.git   # Clone the repo

cd plynx

cp template_config.yaml config.yaml                 # Make a copy of a config
make up                                         # to start production services

Then go to http://localhost:3001

It will start the following services:

MongoDB instance

PLynx User Interface

API service

DAG worker

Several Python and Bash workers (5 by default)

Run make down to stop the services.

Other make commands¶

make build - build all docker images.
make run_tests - build docker images and run the tests.
make up - run the services locally.
make down - shut down services.
make dev - run developer version of PLynx.