Proof Of Concept to run a Matrix client on Android devices using the Matrix Rust Sdk and Jetpack Compose
Go to file
renovate[bot] 39701c6706 Update dependency org.matrix.rustcomponents:sdk-android to v0.1.5 2023-03-29 10:39:36 +02:00
.github Remove automation to sync Element Android strings. 2023-03-20 11:25:53 +01:00
.idea Add project icon. 2023-02-03 16:48:13 +01:00
.maestro [Strings] Update test after string change 2023-03-27 14:44:24 +02:00
anvilannotations Fix lint warning 2023-03-17 09:57:30 +01:00
anvilcodegen enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS") 2023-01-20 19:13:44 +01:00
app Add utility methods for automatically including api/impl feature modules 2023-03-23 18:06:32 +01:00
appnav [Room Details] Implement room details screen (#256) 2023-03-29 05:16:27 +00:00
changelog.d [Room Details] Implement room details screen (#256) 2023-03-29 05:16:27 +00:00
docs [Templates] changes after review 2023-03-27 17:43:02 +02:00
features [Room Details] Implement room details screen (#256) 2023-03-29 05:16:27 +00:00
gradle Update dependency org.matrix.rustcomponents:sdk-android to v0.1.5 2023-03-29 10:39:36 +02:00
libraries [Room Details] Implement room details screen (#256) 2023-03-29 05:16:27 +00:00
plugins Merge branch 'develop' into feature/fga/module_templates 2023-03-27 17:21:45 +02:00
samples/minimal Display most recent activity in room list (#220) 2023-03-20 11:18:25 +01:00
services [Room Details] Implement room details screen (#256) 2023-03-29 05:16:27 +00:00
tests/uitests [Room Details] Implement room details screen (#256) 2023-03-29 05:16:27 +00:00
tools [Room Details] Implement room details screen (#256) 2023-03-29 05:16:27 +00:00
.editorconfig Format project 2022-12-09 12:06:37 +01:00
.gitattributes Setup git lfs 2023-01-18 15:20:32 +01:00
.gitignore Add localazy.json 2023-03-17 15:12:27 +00:00
AUTHORS.md Add AUTHORS.md file 2023-01-11 16:54:50 +01:00
CHANGES.md Setup towncrier 2023-01-11 14:57:14 +01:00
CONTRIBUTING.md Add some docs - lots of outdated part. 2023-01-11 17:02:56 +01:00
Gemfile Add Gemfile to be able to run danger locally. 2023-01-19 11:13:48 +01:00
LICENSE Initial commit 2022-10-06 09:59:25 +02:00
README.md Merge pull request #178 from vector-im/kittykat-patch-2 2023-03-16 11:33:46 +01:00
build.gradle.kts [Room Details] Implement room details screen (#256) 2023-03-29 05:16:27 +00:00
gradle.properties Enable `testFixtures` - but not supported by AGP yet, so put files in module `matrixtest` 2023-02-07 10:36:29 +01:00
gradlew Create project from AS wizard "Empty Compose Activity (Material 3)" 2022-10-07 15:05:13 +02:00
gradlew.bat Create project from AS wizard "Empty Compose Activity (Material 3)" 2022-10-07 15:05:13 +02:00
settings.gradle.kts Include again the module rustsdk, since it's not detected by the fun `includeProjects()` 2023-03-28 21:58:46 +02:00
towncrier.toml Setup towncrier 2023-01-11 14:57:14 +01:00

README.md

Latest build Quality Gate Status Vulnerabilities Bugs codecov Element Android Matrix room #element-android:matrix.org Weblate

element-x-android

ElementX Android is a Matrix Android Client provided by Element. This app is currently in a pre-alpha release stage with only basic functionality.

The application is a total rewrite of Element-Android using the Matrix Rust SDK underneath and targeting devices running Android 6+. The UI layer is written using Jetpack compose.

Screenshots

Here are some early screenshots of the application:

Rust SDK

ElementX leverages the Matrix Rust SDK through an FFI layer that the final client can directly import and use.

We're doing this as a way to share code between platforms and while we've seen promising results it's still in the experimental stage and bound to change.

Status

This project is in work in progress. The app does not cover yet all functionalities we expect.

Contributing

Please see our contribution guide.

Come chat with the community in the dedicated Matrix room.

Build instructions

Just clone the project and open it in Android Studio. Makes sure to select the app configuration when building (as we also have sample apps in the project).

Support

When you are experiencing an issue on ElementX Android, please first search in GitHub issues and then in #element-android:matrix.org. If after your research you still have a question, ask at #element-android:matrix.org. Otherwise feel free to create a GitHub issue if you encounter a bug or a crash, by explaining clearly in detail what happened. You can also perform bug reporting (Rageshake) from the Element application by shaking your phone or going to the application settings. This is especially recommended when you encounter a crash.

Copyright (c) 2022 New Vector Ltd

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.