Skip to content
Open source Android app for your conferences
Kotlin Java Shell
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
.idea
app 🐛 Add applicationComponent when setting up AboutComponent Oct 27, 2019
docs update the setup and README docs Apr 7, 2018
gradle/wrapper Update Gradle [5.3.1 -> 5.4.1] Jun 8, 2019
renderthread Auto-migrate to androidX, then fix all red Jul 28, 2018
team-props Update Detekt [1.0.0-RC14 -> 1.0.0-RC15] Jun 8, 2019
.editorconfig
.gitignore
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Nov 22, 2017
CONTRIBUTING.md
CONTRIBUTORS.md
LICENSE
README.md Rip out FOSSA as it's junk Mar 30, 2019
build.gradle
dependencies.gradle update workmanager to androidx Jun 23, 2019
gradle.properties Auto-migrate to androidX, then fix all red Jul 28, 2018
gradlew Update Gradle [5.2.1 -> 5.3] Mar 30, 2019
gradlew.bat
settings.gradle

README.md

Squanchy Android

Master CI Apache 2 license

Squanchy is an open source platform for conferences. The source code for the Firebase backend and for the Flutter port of the app is available in other repositories of this organisation.

Documentation is available on http://squanchy.net/. The project is maintained by independent contributors (see CONTRIBUTORS.md).

Setting up the app

Starting your own conference app is easy and requires little effort, but you need to prepare some files. See docs/setup.md for detailed instructions.

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.

Git hooks

The project uses Detekt and KtLint to validate Kotlin code before committing. This is done with a Git pre-commit hook, which is automatically installed by Gradle when the clean or assemble tasks are run. You can also install the hook manually from Gradle by executing the 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.

License

Squanchy Android is released under Apache 2.0 licence. See the LICENSE file.

You can’t perform that action at this time.