mirror of
https://github.com/anultravioletaurora/Jellify.git
synced 2025-12-16 18:55:44 -06:00
* refactor: change from yarn to bun for package management * feat: change workflows all to bun instead of node/yarn. * refactor: change from node repl to bun repl * fix: re-add nodejs as an applicable engine to package.json * fix: remove bun.lock from hash in android-build workflow --------- Co-authored-by: Ritesh Shukla <riteshshukla2381@gmail.com>
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
- Ruby for Fastlane
- NodeJS v22 for React Native
- Bun for managing dependencies
🍎 iOS
Dependencies
- Xcode for building
Instructions
Setup
- Clone this repository
- Run
bun init-ios:new-archto initialize the project- This will install
npmpackages, installbundlerand required gems, and install required CocoaPods with React Native's New Architecture
- This will install
- In the
iosdirectory, runfastlane match development --readonlyto fetch the development signing certificates- You will need access to the "Jellify Signing" private repository
Running
- Run
bun startto start the dev server - Open the
Jellify.xcodeworkspacewith Xcode, not theJellify.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
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