mirror of
https://github.com/ouchadam/small-talk.git
synced 2025-02-19 21:50:48 +01:00
90 lines
2.9 KiB
Markdown
90 lines
2.9 KiB
Markdown
# SmallTalk [](https://github.com/ouchadam/small-talk/actions/workflows/assemble.yml) [](https://codecov.io/gh/ouchadam/small-talk) [](https://opensource.org/licenses/Apache-2.0)  
|
|
|
|
`SmallTalk` is a minimal, modern, friends and family focused Android messenger. Heavily inspired by Whatsapp and Signal, powered by Matrix.
|
|
|
|
|
|
|
|
[<img align="right" height="70" src="https://github.com/ouchadam/small-talk/blob/main/.github/readme/google-play-badge.png?raw=tru"></a>](https://play.google.com/store/apps/details?id=app.dapk.st)
|
|
|
|
<br>
|
|
<br>
|
|
<br>
|
|
|
|
|
|
### Project mantra
|
|
- Tiny app size - currently 1.80mb~ when provided via app bundle.
|
|
- Focused on reliability and stability.
|
|
- Bare-bones feature set.
|
|
|
|
---
|
|
|
|
### Feature list
|
|
|
|
- Login with Matrix ID/Password
|
|
- Combined Room and DM interface
|
|
- End to end encryption
|
|
- Message bubbles, supporting text, replies and edits
|
|
- Push notifications (DMs always notify, Rooms notify once)
|
|
- Importing of E2E room keys from Element clients
|
|
- [UnifiedPush](https://unifiedpush.org/)
|
|
- FOSS variant
|
|
|
|
### Planned
|
|
|
|
- Device verification (technically supported but has no UI)
|
|
- Invitations (technically supported but has no UI)
|
|
- Room history
|
|
- Message media
|
|
- Cross signing
|
|
- Google drive backups
|
|
- Markdown subset (bold, italic, blocks)
|
|
- Changing user name/avatar
|
|
- Room settings and information
|
|
- Exporting E2E room keys
|
|
- Local search
|
|
- Registration
|
|
|
|
---
|
|
|
|
#### Technical details
|
|
|
|
- Built on Jetpack compose and kotlin multiplatform libraries ktor and sqldelight (although the project is not currently setup to be multiplatform until needed).
|
|
- Greenfield matrix SDK implementation, focus on separation, testability and parallelisation.
|
|
- Heavily optimised build script, clean _cacheless_ builds are sub 10 seconds with a warmed up gradle daemon.
|
|
- Avoids code generation where possible in favour of build speed, this mainly means manual DI.
|
|
- A pure kotlin test harness to allow for critical flow assertions [Smoke Tests](https://github.com/ouchadam/small-talk/blob/main/test-harness/src/test/kotlin/SmokeTest.kt), currently Linux x86-64 only.
|
|
|
|
---
|
|
|
|
|
|
### Building
|
|
|
|
|
|
##### Debug `.apk`
|
|
|
|
```bash
|
|
./gradlew assembleDebug
|
|
```
|
|
|
|
##### Release (signed with debug key) `.apk`
|
|
|
|
```bash
|
|
./gradlew assembleRelease
|
|
```
|
|
|
|
##### Unsigned release `.apk`
|
|
|
|
```bash
|
|
./gradlew assembleRelease -Punsigned
|
|
```
|
|
|
|
##### Unsigned release (FOSS) `.apk`
|
|
|
|
```bash
|
|
./gradlew assembleRelease -Punsigned -Pfoss
|
|
```
|
|
|
|
---
|
|
|
|
#### Join the conversation @ https://matrix.to/#/#small-talk:iswell.cool
|