DEVELOPMENT.md

Development

The pixelfed mobile app is written in react native and builds on the expo framework.

Requirements

• git-lfs
• yarn package manager
• watchman
• Building for android:
  • android studio and java
• Building for iOS:
  • xcode

https://docs.expo.dev/get-started/set-up-your-environment/ helps you to install most of the dependencies except for git-lfs.

First time setup

corepack enable   # prerequisite to install yarn automatically on next step
yarn              # install dependencies

Also follow steps in https://docs.expo.dev/get-started/set-up-your-environment/

Build the project

yarn start

Web

yarn web

Android

yarn android

iOS

yarn ios

check for ts errors and lint problems

yarn check

fix formatting & linting

yarn lint

Troubleshooting

node not fount

If iOS build complains about not being able to find node, but you can use node just fine, then run:

echo export NODE_BINARY=$(command -v node) > ios/.xcode.env.local

missing .mm file in pods

when you get an error like this one:

error: Build input file cannot be found: '/Users/me/Coding/pixelfed/pixelfed-rn/node_modules/react-native/React/Fabric/RCTThirdPartyFabricComponentsProvider.mm'. Did you forget to declare this file as an output of a script phase or custom build rule which produces it? (in target 'React-RCTFabric' from project 'Pods')

then you might be able to fix it by:

cd ios
pod install