Proof Of Concept to run a Matrix client on Android devices using the Matrix Rust Sdk and Jetpack Compose
 
 
 
 
 
 
Go to file
Benoit Marty dd316aad3c
Merge pull request #2456 from element-hq/renovate/io.mockk-mockk-1.x
Update dependency io.mockk:mockk to v1.13.10
2024-03-01 18:27:24 +01:00
.github A gradle task will be run now, so we need Java 17 and gradle setup. 2024-02-29 10:08:24 +01:00
.idea Kotlin 1.9.22 2024-01-23 13:32:13 +01:00
.maestro Update Maestro test after wording change. 2024-02-23 15:28:47 +01:00
anvilannotations Update Gradle to 8.1 and AGP to v8.0 (#329) 2023-04-17 08:49:52 +00:00
anvilcodegen Fix ktlint issues 2024-01-10 19:33:39 +01:00
app Remove Modifier parameter in private function when only default value is used. 2024-02-08 11:06:06 +01:00
appconfig Fix ktlint issues 2024-01-10 19:33:39 +01:00
appnav Show blocked users list (#2437) 2024-02-26 15:24:22 +00:00
changelog.d Changelog for version 0.1.0 2023-07-19 16:40:45 +02:00
docs Fix small typos 2024-01-31 11:51:30 +01:00
fastlane/metadata/android/en-US Merge tag 'v0.4.5' into develop 2024-02-28 15:13:28 +01:00
features Fix layout issue, issue only visible when text is longer (French, German, etc.) 2024-03-01 15:57:13 +01:00
gradle Update dependency io.mockk:mockk to v1.13.10 2024-03-01 16:46:03 +00:00
libraries Sync Strings from Localazy 2024-02-29 13:48:26 +00:00
plugins Bump version patch. 2024-02-29 13:25:17 +01:00
samples/minimal RoomListFilters : use kotlin filtering as rust one is slower and has more chance to bust the room list cache. 2024-02-27 16:24:54 +01:00
screenshots Update README.md 2024-03-01 16:32:11 +01:00
services Analytics : add analytics on read status and favorite toggles 2024-02-19 17:38:17 +01:00
tests Merge pull request #2481 from element-hq/feature/bma/fixLayoutRoomEmpty 2024-03-01 18:00:04 +01:00
tools Simple Html page to view all the screenshots. 2024-03-01 15:10:18 +01:00
.editorconfig Ktlint: disable rule standard:blank-line-before-declaration. 2024-01-10 19:31:36 +01:00
.gitattributes Generate screenshots for foreign languages ("de" and "fr" for now). #2454 2024-02-28 14:30:34 +01:00
.gitignore Extract compound tokens and theming to `compound-android` library (#1888) 2023-11-27 10:30:07 +01:00
AUTHORS.md Organization renaming: replace all `https://github.com/vector-im` by `https://github.com/element-hq` 2023-12-13 09:40:07 +01:00
CHANGES.md Changelog for version 0.4.5 2024-02-28 11:01:39 +01:00
CODEOWNERS Update CODEOWNERS after organization renaming 2023-12-12 13:54:32 +01:00
CONTRIBUTING.md Remove `_`, added by mistake. 2024-02-05 15:25:39 +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 Remove `_`, added by mistake. 2024-02-05 15:25:39 +01:00
build.gradle.kts Simple Html page to view all the screenshots. 2024-03-01 15:10:18 +01:00
gradle.properties Only apply dependencyanalysis plugin to some modules 2023-12-28 17:06:05 +01:00
gradlew Update dependency gradle to v8.4 (#1496) 2023-10-06 08:38:36 +02:00
gradlew.bat Update dependency gradle to v8.2 (#744) 2023-07-04 10:54:32 +02:00
settings.gradle.kts StartDM : add tests 2023-11-30 18:05:26 +01:00
towncrier.toml Organization renaming: replace all `https://github.com/vector-im` by `https://github.com/element-hq` 2023-12-13 09:40:07 +01:00

README.md

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

Element X Android

Element X Android is a Matrix Android Client provided by element.io. This app is currently in a pre-alpha release stage with only basic functionalities.

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, and the navigation is managed using Appyx.

Learn more about why we are building Element X in our blog post: https://element.io/blog/element-x-experience-the-future-of-element/.

Table of contents

Screenshots

Here are some early screenshots of the application:

Rust SDK

Element X 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. The list of supported features can be found in this issue.

Contributing

Want to get actively involved in the project? You're more than welcome! A good way to start is to check the issues that are labelled with the good first issue label. Let us know by commenting the issue that you're starting working on it.

But first make sure to read our contribution guide first.

You can also come chat with the community in the Matrix room dedicated to the project.

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 Element X Android, please first search in GitHub issues and then in #element-x-android:matrix.org. If after your research you still have a question, ask at #element-x-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 from the application settings. This is especially recommended when you encounter a crash.

Copyright © 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.