Files
App/CONTRIBUTING.md
Violet Caulfield 18136cd8d8 stop buffering if a skip has been requested (#894)
* stop buffering if a skip has been requested

* clean up eventing in player provider

fixes #833

* please refresh homescreen more often

* clean up context provider a bit

* smol optimizations

deduplicate player logic for previous and skip

* update CONTRIBUTING documentation

* add react-freeze to prevent unfocused screens from rerendering

* freeze similar until the albums have loaded

* remove unneeded hooks in a variety of played

* display a spinner when loading albums by an artist

* make add to playlist a bit faster and lazier

* move player hooks from provider folder since they aren't dependent on a context provider

* add ability to refresh an artist's page

* add ability to refresh albums too

* make adding a track to a playlist faster

* set query client data when a track is added to a playlist

* do the same trick for removing and reordering tracks from a playlist

* hide miniplayer if the big player is focused for reduced overhead

* fix some styling in the miniplayer
2026-01-07 15:13:38 -06:00

2.5 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

🍎 iOS

Dependencies

Instructions

Setup
  • Clone this repository
  • Run bun init-ios to initialize the project
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