mirror/App
1
0
Fork 0
mirror of https://github.com/Jellify-Music/App.git synced 2025-12-16 16:26:33 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
App/CONTRIBUTING.md
Brys 9d2e10e996 Switch from Yarn/Node.js to bun for faster dev install (#704) 
* 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>
2025-11-23 17:31:24 -06:00

2.8 KiB
Raw Permalink Blame History

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

🍎 iOS

Dependencies

Instructions

Setup
  • Clone this repository
  • Run bun init-ios:new-arch to initialize the project
  • 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 bun 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 bun fastlane:ios:build to use fastlane to compile an .ipa

🤖 Android

Dependencies

Instructions

Setup
  • Clone this repository
  • Run bun install to install npm packages
Running
  • Run bun 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 bun fastlane:android:build to use fastlane to compile an .apk for all architectures
  • Alternatively, run cd android; ./gradlew assembleRelease to use Gradle to compile an .apk

References

Reference in New Issue View Git Blame Copy Permalink