Thanks for contributing to Confetti 🎊!
Confetti is a conference app to experiment with the latest Kotlin technologies and libraries, share best practices and have fun!
Contributions are very welcome.
If you have a feature you want to implement or found a bug, feel free to open an issue and we can discuss how to best implement/fix it.
If you don't know where to start, you can also take a look at the list of good first issues for good places to get started with the project.
Documentation, UX, design, data contributions are very welcome.
If you see a conference missing in the list, please let us know by opening an issue.
At the time of writing, in order to build the Confetti app, you'll need:
- JDK 17+, you can get one with Homebrew on macOS or with you favorite package manager.
- Android Studio Electric Eel or higher.
- Xcode 14.2+ for the iOS app
To checkout the sources you need to install git-lfs:
- Download git-lfs on your system:
brew install git-lfs - install git-lfs in your workspace folder:
git lfs install
Now you can clone the Github repository: git clone https://github.com/joreilly/Confetti
For Android, open the root project in Android Studio. Useful tasks:
./gradlew :androidApp:assembleDebug./gradlew :wearApp:assembleDebug
For iOS, open the iosApp/iosApp.xcodeproj in Xcode and run the app.
API docs are available at backend/README.md
You can run the backend locally with the following task:
./gradle :backend:service-graphql:bootRun
When running bootRun, you will only be able to use the "test" conference as access to the real data requires additional credentials.
Happy hacking!