Skip to content

Getting Started with railbird-mobile

This document describes how to get started with the railbird-mobile repository.

Install Nix

Follow the instructions at nix at railbird docs for installing nix.

Set up git and gitea

Follow the instructions about gettting set up with git.

Initialize the nix flake development environment

With direnv

Make sure that you have given our .envrc permission with direnv allow

Controlling the Default Shell

We recommend that you add a file .envrc.override to allow control over which development environment you enter (either iOS or Android).

platform=ios
use flake ".#$platform" --impure

When using this setup, simply change the value to which platform is assigned and run direnv reload to switch shells.

With nix develop

Android

nix develop .#android --impure

iOS

nix develop .#ios --impure

Install Node Modules

  • Run yarn install to install the required node modules.

Pod Install (iOS only)

cd railbird-mobile/ios
pod install

Run the App

  • Run the mobile app:

Android

You may need to enter your IP the first time you run the app

On linux, you can get your IP by running:

localip

 yarn expo start --dev-client

iOS

yarn expo:run ios
You will need to enter a URL manually. To do this, get your IP address by typing localip from the terminal. Enter: http://{localipd}:8081 Make sure you input a public facing IP not a LAN