Linux Setup Guide

This guide provides instructions for setting up the development environment for the futr nostr client on Linux systems.

Docker (Recommended)

The easiest way to get started is using the pre-built Docker image.

To build the project, run the following command:

docker run -it --rm -v $(pwd):/app prolic/futr-dev build

To run the tests, run the following command:

docker run -it --rm -v $(pwd):/app prolic/futr-dev test

To build the Flatpak, run the following command:

docker run -it --rm -v $(pwd):/app prolic/futr-dev flatpak

To enter the shell of the container, run the following command:

docker run -it --rm -v $(pwd):/app prolic/futr-dev shell

Build the docker image

docker buildx build . -t prolic/futr-dev

Manual Setup (Ubuntu / Linux Mint)

For all other Linux distros, you can use the Docker image or follow the Ubuntu / Linux Mint instructions below. You might need to adjust the package names for your distro.

GHCUp

You can grab GHCUp from the GHCUp website.

sudo apt-get install build-essential zlib1g-dev
curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh
ghcup install ghc 9.6.7
ghcup install cabal 3.10.3.0
ghcup set ghc 9.6.7
ghcup set cabal 3.10.3.0

Qt5 & LMDB

sudo apt-get install qtdeclarative5-dev \
                     qml-module-qtquick-controls2 \
                     libqt5quick5 \
                     qttools5-dev-tools \
                     qtbase5-dev \
                     qtmultimedia5-dev \
                     qml-module-qtmultimedia \
                     qt5-image-formats-plugins \
                     liblmdb-dev

secp256k1 (from source)

sudo apt-get install autoconf autogen automake libtool
git clone https://github.com/bitcoin-core/secp256k1 && \
    cd secp256k1 && \
    git checkout v0.5.1 && \
    ./autogen.sh && \
    ./configure --enable-module-schnorrsig --enable-module-extrakeys --enable-module-ecdh --enable-experimental --enable-module-recovery && \
    make && \
    make install && \
    cd ..

Building

cabal build

Building Flatpak

cabal build
./build-flatpak.sh

Profiling

Install ghc-prof-flamegraph if you haven't already:

cabal install ghc-prof-flamegraph

Build and run the program with profiling:

cabal build --enable-profiling --ghc-options="-fprof-auto -rtsopts"
LC_ALL=C cabal run --enable-profiling futr -- +RTS -p

Watch the output:

less futr.prof

Generate the flamegraph:

ghc-prof-flamegraph futr.prof

Open the generated file in your browser:

xdg-open futr.svg