79 lines (51 loc) · 2.8 KB

👩‍💻 Contributing

We are open to any developer that wants to lend their hand at Jellify development, and developers can join our Discord server to get in contact with us.

Here's the best way to get started:

Fork this repository
Follow the instructions for Running Locally
Check out the issues if you need inspiration
Hack, hack, hack
???
Submit a Pull Request to sync the main repository with your fork
Profit! 🎉

🏃‍♀️Running Locally

⚛️ Universal Dependencies

Ruby for Fastlane
NodeJS v22 for React Native
Maestro for running E2E tests

🍎 iOS

Dependencies

Xcode for building

Instructions

Setup

Clone this repository
Run yarn init-ios:new-arch to initialize the project
- This will install npm packages, install bundler and required gems, and install required CocoaPods with React Native's New Architecture
In the ios directory, run fastlane match development --readonly to fetch the development signing certificates
- You will need access to the "Jellify Signing" private repository

Running

Run yarn start to start the dev server
Open the Jellify.xcodeworkspace with Xcode, not the Jellify.xcodeproject
Run either on a device or in the simulator
- You will need to wait for Xcode to finish it's "Indexing" step

Building

To create a build, run yarn fastlane:ios:build to use fastlane to compile an .ipa

🤖 Android

Dependencies

Instructions

Setup

Clone this repository
Run yarn install to install npm packages

Running

Run yarn start to start the dev server
Open the android folder with Android Studio
- Android Studio should automatically grab the "Run Configurations" and initialize Gradle
Run either on a device or in the simulator

Building

To create a build, run yarn fastlane:android:build to use fastlane to compile an .apk for all architectures

References