Skip to content

Development

github-actions[bot] edited this page Nov 17, 2026 · 1 revision

Development

How to set up LibreLifts and run each part of it.

Requirements

  • Node 26 (see .nvmrc) and pnpm 12.
  • For iOS: Xcode with an iOS simulator, and CocoaPods.
  • For Android: the Android SDK with an emulator, and Java 17.

The web app, the desktop shell, the website and the tests need only Node and pnpm.

Install

pnpm install

The app

The app is in apps/app. One codebase runs on web, iOS and Android.

pnpm app web        # web, on http://localhost:8081
pnpm app ios        # build and run in the iOS simulator
pnpm app android    # build and run in an Android emulator

The native projects in apps/app/ios and apps/app/android are generated by the build and are not committed. Change native settings in apps/app/app.json, not in those folders.

Install packages that Expo manages with npx expo install <package> from apps/app, so their versions match the Expo SDK.

If the iOS build fails in CocoaPods

pod install can crash with "Unicode Normalization not appropriate for ASCII-8BIT" when the shell has no UTF-8 locale. Set one and run the build again:

export LANG=en_US.UTF-8

If the Android app can't load its bundle

A debug build loads its code from the dev server on your machine. Forward the port to the emulator, then reopen the app:

adb reverse tcp:8081 tcp:8081

The desktop shell

apps/desktop is an Electron app that serves the web build of the app.

pnpm desktop start   # export the web build, compile the shell, open the window
pnpm desktop pack    # the same, then package an unsigned app into apps/desktop/release

The website

apps/website is the static site at librelifts.app.

pnpm website dev     # http://localhost:4321
pnpm website build   # build into apps/website/dist and check the result
pnpm website icons   # regenerate the favicon and icons from the logo mark

The build fails if a built page contains a <script> or a link on it doesn't resolve.

Tests and checks

pnpm test        # unit tests (packages/core)
pnpm typecheck   # TypeScript, in every package
pnpm lint        # Biome
pnpm format      # Biome, fixing what it can

The docs and the wiki

The wiki is built from docs/. To see what will be published:

pnpm wiki        # writes the wiki pages to dist/wiki

It fails if a link between docs doesn't resolve.

Clone this wiki locally