Quark

Quark is a secure messaging application for Android, featuring quantum-resistant encryption.

Installation

For a compiled APK, see releases. For development setup, scroll on.

Index

• Installation
• Index
• Building from source
• Testing
  • Prerequisites
  • CLI
  • Android Studio
• Contributing
• License

Building from source

Using Android Studio is highly recommended for any Android development.

Use

./gradlew assembleDebug 

or

.\gradlew.bat assembleDebug

in the root of the project to build an APK from the command line. You can also deploy to an Android device or emulator from the command line, using

./gradlew installDebug

See here for more info.

Testing

Prerequisites

• NPM
• Running Android Emulator (just start it with Android Studio instead)

To install the necessary dependencies with NPM, run:

npm i

Testing in CLI

For on-device-testing, run:

npm run firebase-test

For developer-side testing, run:

npm run test

Testing in Android Studio

If you want to run tests using Android Studio, make sure you have the firebase server running using:

npm run start-firebase

And use Ctrl-C in the terminal to stop the server.

If, for whatever reason, you need to manually stop the server, use:

npm run stop-firebase

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

GPL-3.0