Go to file

Krille-chan f3e249dab3 Merge pull request #1960 from famedly/krille/store-room-states-as-tripple-keys refactor: Store room states as triple keys		2024-12-09 13:22:28 +01:00
.github	feat: add equality and hashCode overrides for autogenerated models (BREAKING CHANGE)	2024-10-18 14:02:55 +02:00
.gitlab	chore: change codeowners	2022-10-19 10:16:49 +00:00
doc	docs: Add documentation	2024-04-11 15:36:30 +02:00
example	docs: Update example with matrixsdkdatabase	2024-05-27 15:16:41 +02:00
lib	refactor: BREAKING Store room states as triple keys	2024-12-09 12:36:39 +01:00
scripts	feat: move e2e test dind structure to use executor	2024-07-01 20:52:32 +05:30
test	feat: (BREAKING) Replace onMigration with advanced callback onInitStateChanged	2024-12-09 12:33:15 +01:00
test_driver	chore: add require trailing comma lint	2024-11-07 16:13:37 +01:00
web_test	feat: add Web build test	2024-04-12 08:50:53 +02:00
.gitignore	chore: use proper matchers in integration tests	2022-12-14 14:45:58 +01:00
.gitlab-ci.yml	feat: Implement new Matrix Dart SDK Database	2023-12-06 12:11:47 +01:00
.metadata	Initial commit	2019-06-09 12:16:48 +02:00
CHANGELOG.md	build: Bump version	2024-11-11 16:57:20 +01:00
CONTRIBUTING.md	docs: Clean up repository docs	2021-05-18 11:41:53 +00:00
LICENSE	Update LICENSE	2019-06-09 11:36:59 +00:00
README.md	chore: add info about tests to readme	2024-07-31 14:13:30 +05:30
analysis_options.yaml	chore: add require trailing comma lint	2024-11-07 16:13:37 +01:00
dart_test.yaml	feat: lcov and tag olm tests	2024-04-23 15:21:46 +05:30
pubspec.yaml	build: Bump version	2024-11-11 16:57:20 +01:00

README.md

Matrix SDK

Matrix (matrix.org) SDK written in dart.

Native libraries

For E2EE, libolm must be provided.

Additionally, OpenSSL (libcrypto) must be provided on native platforms for E2EE.

For flutter apps you can easily import it with the flutter_olm and the flutter_openssl_crypto packages.

flutter pub add matrix
flutter pub add flutter_olm
flutter pub add flutter_openssl_crypto

Get started

See the API documentation for details:

API documentation

Tests

thread_count=$(getconf _NPROCESSORS_ONLN) // or your favourite number :3
dart test --concurrency=$thread_count test

Adding the -x olm flag will skip tests which require olm
Using -t olm will run only olm specific tests, but these will probably break as they need prior setup (which is not marked as olm and hence won't be run)