Skip to content

Latest commit

 

History

History
111 lines (64 loc) · 3.17 KB

DEVELOPMENT.md

File metadata and controls

111 lines (64 loc) · 3.17 KB

App and API

Local development

Requirements

  • nodejs & nvm to activate and manage multiple node versions
  • python 3+ and a python version manager such as pyenv or conda
  • bash friendly terminal

TLDR

Prepare development environment

  1. Install development tools for your OS

    • sudo pacman -Sy base-devel - Arch flavors
    • sudo yum groupinstall "Development Tools" "Legacy Software Development" - Fedora
    • sudo apt-get install build-essential - Debian / Ubuntu & friends
    • Get homebrew - for MacOS
    • Native Windows - on your own, for WSL, use any of the Linux guides above!

  2. Install nvm - for managing multiple node versions, this project uses version pinning, because OS package-manager provided nodejs is usually not proper for development.

    • curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

    Don't forget to setup your shell environment as described by nvm.

  3. Install the PM tool invoke - this is to support automation and fast REPL development environment.

    • pip install -r support/requirements.txt

Prepare project infrastructure

inv prepare - Fetch all dependencies using

Live development with hot reloading

inv start - To start development servers

Build the project assets

inv build - Compiles assets

Bundle the project assets

inv bundle - Creates application bundles

Release the project binaries

inv release - Compiles assets and creates application bundles with production settings

  • Ensure flatpak builder is installed:

    sudo apt-get install -y flatpak flatpak-builder elfutils
flatpak remote-add --if-not-exists --user flathub https://flathub.org/repo/flathub.flatpakrepo
git config --global --add protocol.file.allow always

  • Ensure flatpak user repos exist:

    flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo

  • Ensure rpm tooling is available:

    sudo apt-get install rpm

  • Ensure libarchive-tools is installed to be able to create pacman packages

    sudo apt-get install -y libarchive-tools

Other useful info

  • Start API as socket (socketPath for axios)

    podman system service --time=0 unix:///tmp/podman.sock --log-level=debug

  • Test socket api

    curl --unix-socket /tmp/podman.sock http://d/v3.0.0/libpod/info

  • Start API as http server - HTTP api is only for development - insecure!

    podman system service tcp:localhost:8081 --time=0 --log-level=debug --cors="*"

  • Test http api

    curl -X GET http://localhost:8081/v3.0.0/libpod/info

Deployment

podman system connection add default "//wsl.localhost/Ubuntu-24.04/home/$USER/.ssh/id_rsa" --socket-path "\wsl.localhost\Ubuntu-24.04\mnt\wslg\runtime-dir\podman\podman.sock"

Get URI

podman system connection ls

Create tunnel

ssh -nNT -L/tmp/podman.sock:/run/user/1000/podman/podman.sock -i ~/.ssh/podman-machine-default ssh://core@localhost:[PORT]

Export socket location

export DOCKER_HOST='/tmp/podman.sock'