mirror of
https://github.com/Jellify-Music/App.git
synced 2026-03-17 10:40:38 -05:00
2.8 KiB
2.8 KiB
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
- NodeJS v22 for React Native
- Bun for managing dependencies
🍎 iOS
Dependencies
- Xcode for building
Instructions
Setup
- Clone this repository
- Run
bun init-iosto initialize the project- This will install
npmpackages, installbundlerand required gems, and install required CocoaPods with React Native's New Architecture
- This will install
Running
-
Run
bun startto start the dev server -
Open the
Jellify.xcodeworkspacewith Xcode, not theJellify.xcodeproject -
Run in the simulator
- You will need to wait for Xcode to finish it's "Indexing" step
-
To run on device, you will need access to the Signing Repository
- Setup a GitHub Personal Access Token and export it to a variable "MATCH_REPO_PAT"
- Run
bun fastlane:ios:matchto fetch the signing keys and certificates
Building
- To create a build, run
bun fastlane:ios:buildto use fastlane to compile an.ipa
🤖 Android
Dependencies
Instructions
Setup
- Clone this repository
- Run
bun installto installnpmpackages
Running
- Run
bun startto start the dev server - Open the
androidfolder 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
bun fastlane:android:buildto use fastlane to compile an.apkfor all architectures - Alternatively, run
cd android; ./gradlew assembleReleaseto use Gradle to compile an.apk