QuickStart

By following this tutorial, you'll see how easy it is to deploy web applications to Golem.

You should be able to complete it regardless of your level of experience. However, it will help if you have some fluency using basic unix tools like curl or git and are not afraid of running console commands.

To launch applications on Golem, you request computational resources from the network. Therefore, you need the following prerequisites prior to execution:

• a running yagna service (v0.12 or higher)
• your requestor app key

Setting these up is a part of the Yagna installation instructions.

Please also ensure you have curl available on your system.

curl --version

If not, please install it using the instructions appropriate for your system from: https://curl.se/download.html.

It's best to run any Python application in a virtual environment. It will let you avoid cluttering your system's Python installation with unnecessary packages.

Ensure you're running Python >= 3.8, and you have the venv module installed (it's normally included in the Python distribution).

Prepare a virtual environment for the tutorial script:

python3 -m venv --clear ~/.envs/dapps
source ~/.envs/dapps/bin/activate

The tool which deploys apps to Golem, dapp-runner is installable from the PyPi repository with the following command:

pip install -U pip dapp-runner

curl https://raw.githubusercontent.com/golemfactory/dapp-store/81e3f50aba90a84d335a26cb9cc2ea778193be11/apps/todo-app.yaml > webapp.yaml

curl https://raw.githubusercontent.com/golemfactory/dapp-runner/main/configs/default.yaml > config.yaml

Generate an unique api-key with the yagna command:

yagna app-key create dapp-runner

It will produce a 32-char key.

Copy and export it:

export YAGNA_APPKEY=<your key>

Having the above setup complete, you can verify it by running a sample application that comes together with dapp-runner repository using the following commands:

dapp-runner start --config config.yaml webapp.yaml

Once the app is deployed on Golem, you should see a line reading:

{"web": {"local_proxy_address": "http://localhost:8080"}}

This means that the app is ready and can be viewed at: http://localhost:8080

(The port on your machine may be different)

That's it!