Proof Of Concept to run a Matrix client on Android devices using the Matrix Rust Sdk and Jetpack Compose
 
 
 
 
 
Go to file
Benoit Marty 4964c3e372 version++ 2023-09-21 23:11:36 +02:00
.github Revert "Update codecov/codecov-action action to v4" 2023-09-15 09:19:30 +02:00
.idea We are now using kotlinc 1.9.10, so Android Studio is updating this file. 2023-08-30 16:59:42 +02:00
.maestro Maestro: ensure the Rich Text Editor can be clicked by Maestro. 2023-09-13 14:33:32 +02:00
anvilannotations Update Gradle to 8.1 and AGP to v8.0 (#329) 2023-04-17 08:49:52 +00:00
anvilcodegen Extract dependencies from group `com.google.auto.service` into libs.versions.toml to avoid multiple PR to upgrade the 2 deps. 2023-06-14 10:33:26 +02:00
app Revert "DI: more cleanup" 2023-09-19 18:07:20 +02:00
appnav Detekt: Rename `DayNightPreviews` to `PreviewsDayNight` to follow naming convention. 2023-09-21 08:30:36 +02:00
changelog.d Changelog for version 0.2.2 2023-09-21 23:10:21 +02:00
docs Draft a documentation about the continuous integration 2023-09-06 09:23:22 +02:00
fastlane/metadata/android/en-US Adding fastlane file for version 0.2.2 2023-09-21 23:10:48 +02:00
features Add animation on the timeline content, to avoid glitch (#1323) 2023-09-21 18:43:46 +02:00
gradle Upgrade Rust SDK to v0.1.57 (#1401) 2023-09-21 19:48:19 +00:00
libraries Merge pull request #1405 from vector-im/feature/bma/timelineGlitch 2023-09-21 22:12:59 +02:00
plugins version++ 2023-09-21 23:11:36 +02:00
samples/minimal Fix test compilation 2023-09-14 19:28:56 +01:00
services Detekt: Rename `DayNightPreviews` to `PreviewsDayNight` to follow naming convention. 2023-09-21 08:30:36 +02:00
tests Update screenshots 2023-09-21 16:03:32 +00:00
tools Merge pull request #1400 from vector-im/feature/bma/fixCrashPhoto 2023-09-21 16:31:36 +02:00
.editorconfig Upgrade ktlint to 0.48.2 2023-04-17 15:18:07 +02:00
.gitattributes Update screenshots of the application 2023-07-26 17:15:51 +02:00
.gitignore Ignore this file. 2023-07-24 12:44:50 +02:00
AUTHORS.md Add AUTHORS.md file 2023-01-11 16:54:50 +01:00
CHANGES.md Changelog for version 0.2.2 2023-09-21 23:10:21 +02:00
CODEOWNERS Create CODEOWNERS 2023-05-09 17:07:23 +02:00
CONTRIBUTING.md Detekt: Rename `DayNightPreviews` to `PreviewsDayNight` to follow naming convention. 2023-09-21 08:30:36 +02: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 Update README.md (#1187) 2023-08-30 14:39:05 +02:00
build.gradle.kts Update dependency io.nlopez.compose.rules:detekt to v0.3.0 2023-09-20 21:21:10 +00:00
gradle.properties Remove suppressUnsupportedCompileSdk 2023-09-15 09:20:51 +02:00
gradlew Update dependency gradle to v8.3 2023-08-17 13:42:52 +00:00
gradlew.bat Update dependency gradle to v8.2 (#744) 2023-07-04 10:54:32 +02:00
settings.gradle.kts Bump telephoto to 0.6.0-SNAPSHOT to diagnose crash (#1164) 2023-08-29 09:59:01 +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 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.