Android Matrix messenger application using the Matrix Rust Sdk and Jetpack Compose
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Benoit Marty 49db79ecad Update doc 2 years ago
.github Merge pull request #31 from vector-im/feature/bma/checkDep 2 years ago
.idea Setup Copyright configuration 2 years ago
anvilannotations Fix warning 2 years ago
anvilcodegen Bump kotlinpoet from 1.10.2 to 1.12.0 2 years ago
app Fix warning 2 years ago
docs Update doc 2 years ago
features Fix warning 2 years ago
gradle dependencycheck 7.4.4 (with fix for https://github.com/dependency-check/dependency-check-gradle/issues/300) 2 years ago
libraries Fix warning 2 years ago
plugins Add missing Copyright 2 years ago
tools Let detekt check if the license is set on Kotlin files. 2 years ago
.editorconfig Format project 2 years ago
.gitignore Move logout and report bug to Setting screen 2 years ago
AUTHORS.md Add AUTHORS.md file 2 years ago
CONTRIBUTING.md Add some docs - lots of outdated part. 2 years ago
LICENSE Initial commit 2 years ago
README.md Add some docs - lots of outdated part. 2 years ago
build.gradle.kts Set up dependency check plugin 2 years ago
gradle.properties Add missing Copyright 2 years ago
gradlew Create project from AS wizard "Empty Compose Activity (Material 3)" 2 years ago
gradlew.bat Create project from AS wizard "Empty Compose Activity (Material 3)" 2 years ago
settings.gradle.kts Create `matrixui` module and remove dependency to `coil` in the matrix module. Move `MatrixUser` there. 2 years ago

README.md

element-x-android

ElementX Android is a Matrix Android Client provided by Element.

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

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.

Roadmap

We are aiming to have a fast and fully functional personal messaging application by the end of year 2023.

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.

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.