Skip to content

Latest commit

 

History

History
139 lines (79 loc) · 3.66 KB

docs.md

File metadata and controls

139 lines (79 loc) · 3.66 KB
Raw

Available actions

These docs are generated from docs.nix via json2md and formatted via markdownlint-cli2. The command to write these docs:

nix run .#writeDocs

Keybindings

  • Command palette - press Ctrl (Cmd) + Shift + P
  • Stop app - press Ctrl (Cmd) + C in the terminal where that app is running
    • Alternatively, run the corresponding task

Warnings

Environment

The commands below read from .env files both from the app_... folders and from the $PROJECT_ROOT. I checked them into the repo to ease the project demonstration. If you'd like to push to your cachix cache or Docker Hub repo, make sure to edit the $PROJECT_ROOT/.env to use locally the tasks that depend on it. Otherwise, you may supply these values as the environment variables via the set -a - trick

Commands and Tasks

If Tasks don't work inside VSCodium, try commands in an ordinary terminal. Start a devshell in the $PROJECT_ROOT:

nix develop

Open VSCodium

nix develop

app_python actions

app_python: Docker build

  1. Command palette -> Tasks: Run Task -> app_python: Docker build

    1. Or (cd app_python && app-python-docker-build)

app_python: Pull 'web' from Docker Hub

  1. Command palette -> Tasks: Run Task -> app_python: Pull 'web' from Docker Hub

    1. Or (cd app_python && app-python-docker-pull)

app_python: Push 'web' to Docker Hub

  1. Command palette -> Tasks: Run Task -> app_python: Push 'web' to Docker Hub

    1. Or (cd app_python && app-python-docker-push)

app_python: Docker run

  1. Command palette -> Tasks: Run Task -> app_python: Docker run

    1. Or (cd app_python && app-python-docker-run)

  2. Open page in a browser

app_python: Docker stop

  1. Command palette -> Tasks: Run Task -> app_python: Docker stop

    1. Or (cd app_python && app-python-docker-stop)

app_python: Run

  1. Command palette -> Tasks: Run Task -> app_python: Run

    1. Or (cd app_python && app-python)

  2. Open page in a browser

app_python: Stop

  1. Press Ctrl (Cmd) + C in the terminal

app_python: Test

app_purescript actions

app_purescript: Docker build

  1. Command palette -> Tasks: Run Task -> app_purescript: Docker build

    1. Or (cd app_purescript && app-purescript-docker-build)

app_purescript: Pull 'web' from Docker Hub

  1. Command palette -> Tasks: Run Task -> app_purescript: Pull 'web' from Docker Hub

    1. Or (cd app_purescript && app-purescript-docker-pull)

app_purescript: Push 'web' to Docker Hub

  1. Command palette -> Tasks: Run Task -> app_purescript: Push 'web' to Docker Hub

    1. Or (cd app_purescript && app-purescript-docker-push)

app_purescript: Docker run

  1. Command palette -> Tasks: Run Task -> app_purescript: Docker run

    1. Or (cd app_purescript && app-purescript-docker-run)

  2. Open page in a browser

app_purescript: Docker stop

  1. Command palette -> Tasks: Run Task -> app_purescript: Docker stop

    1. Or (cd app_purescript && app-purescript-docker-stop)

app_purescript: Run

  1. Command palette -> Tasks: Run Task -> app_purescript: Run

    1. Or (cd app_purescript && app-purescript)

  2. Open page in a browser

app_purescript: Stop

  1. Press Ctrl (Cmd) + C in the terminal

app_purescript: Test