Skip to content

Contributions

František Maša edited this page Aug 3, 2023 · 1 revision

Contributing

For simple changes or bug fixes, don't hesitate to open PR with implementation. If you have an idea for a bigger feature, please open an issue first, so we can discuss it before you invest your time in implementation.

Tech stack

  • Kotlin
  • Jetbrains Compose (Multiplatform version of Jetpack Compose)
  • Firebase (Auth, Firestore, Cloud Functions)

Local development

For development, you will need the current version of Android Studio and ideally an Android device.

The app heavily uses the Firebase services, so the best way to work on this project is to start your own Firestore emulator and use it instead of the production database.

There are just a few steps to do this:

  1. Install Firebase CLI
  2. Start Firestore emulator using firebase emulators:start
  3. Copy the following snippet to your local.properties and replace <HostIP> with your computer's IP:
dev.firestoreEmulatorUrl=<HostIP>\:8080
dev.firestoreEmulatorHost=<HostIP>
dev.functionsEmulatorUrl=<HostIP>\:5051
  1. Ensure that both your device and computer are on the same network and your computer ports are accessible.

Donations

The WFRP Master is and will always remain a free and open-source app. If you are not a developer but would like to support the app anyway, consider recommending the app to your players or a GM. If you want to support me financially, you can do so using Ko-fi.

Ko-fi button

Clone this wiki locally