Setting up the app
Starting your own conference app is easy and requires little effort, but you need to prepare some files. See
Please note that this app uses some third party services:
- Firebase (Firestore, Push messages, etc.)
- Fabric: Crashlytics
While not all of them are strictly necessary for the app to work (with the exception of Firebase's RTDB), it is currently not possible for the code to work without them. We plan on eventually abstracting away the implementations so that they would simply be disabled if there is no API configured, but we haven't done it yet. If you need to use Squanchy without some of those implementations, please feel free to make them optional and contribute back to mainline your changes.
The project uses Detekt and KtLint to validate Kotlin code before committing. This is done with a Git
hook, which is automatically installed by Gradle when the
assemble tasks are run. You can also install the hook manually from Gradle by
installGitHooks task on the root project:
$ ./gradlew installGitHooks.
If you wish to commit code that is failing this test for whatever reason, you can use the
--no-verify flag when committing with
git. Please note
that if you don't address the issues before pushing, the CI will fail the build.