Pakete, Repositories und App-Kategorien suchen

Paketdetailsv5.4.0

crdt_lf

Konfliktfreie replizierte Datentypen (CRDT) - Lokal-zuerst-Implementierung in Dart

AndroidiOSWebmacOSWindowsLinux
30-Tage-Downloads
1370
Likes
8
Pub-Punkte
160

Paket installieren

flutter pub add crdt_lf

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

crdt_lf ist eine Dart-Implementierung von konfliktfreien replizierten Datentypen (CRDTs), die für Anwendungen mit lokaler Priorität entwickelt wurde. Sie ermöglicht nahtlose Echtzeit-Kooperation, indem sie die Datenkonsistenz über mehrere Geräte hinweg sicherstellt, ohne dass ein zentraler Server erforderlich ist. Ideal für reichhaltige Text-, Markdown- und HTML-Editoren unterstützt es Offline-Editing und automatische Konfliktlösung, wenn Verbindungen wiederhergestellt werden. Das Paket ist plattformunabhängig und funktioniert auf Android, iOS, Web, macOS, Windows und Linux.

Anwendungsfälle

  • Echtzeit-kollaborative Textbearbeitung
  • Dokumentenbearbeitung mit Fokus auf Offline
  • Mehrfachgeräte-Synchronisierung für reichhaltige Text-Apps
  • Dezentrale Inhaltsverwaltung
  • Markdown-Dokumente zwischen Geräten synchronisieren

Hauptmerkmale

  • konfliktfreie Daten-Synchronisierung
  • Unterstützt Offline-Betrieb
  • Automatische Zusammenführung konkurrierender Änderungen
  • Leichtgewichtig und effizient
  • Plattformübergreifende Kompatibilität
  • Eingebaute Unterstützung für reichhaltige Textstrukturen

Geeignet für

  • Kooperationswerkzeuge für die Schreibarbeit
  • Offline-fähige Notiz-Apps
  • Verteilte Inhaltseditoren
  • Apps, die Echtzeit-Synchronisierung ohne Server erfordern
  • Entwickler, die lokale-first-Anwendungen erstellen

Hinweise

  • Kenntnisse der CRDT-Prinzipien erforderlich
  • Kann bei großen Datensätzen einen höheren Speicherverbrauch haben
  • Nicht ideal für häufige Aktualisierungen ohne Optimierung
  • Beschränkte Dokumentation außerhalb grundlegender Beispiele
  • Am besten geeignet für strukturierten Text und nicht für Binärdaten

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

CRDT

github_starts melos_badge repo_size

logo

docs_badge

Apps

Packages

Roadmap

A roadmap is available in the project page. The roadmap provides a high-level overview of the project's goals and the current status of the project.

Workspace structure

This repository is a workspace that contains multiple packages and apps. Consistency is granted by the melos tool.

Melos

Melos (pub.dev) is a CLI tool for Dart/Flutter monorepos. It links the local packages together, so every package can depend on the others without publishing them first, and it runs the same command over all of them (format, analyze, test, publish, ...).

Every shared command lives in melos.yaml and runs with melos run <script>:

Script What it does
format formats the code (80 characters per line)
analyze runs the analyzer with warnings and infos as errors
test / test_flutter / test_chrome runs the Dart, Flutter and web tests
benchmark runs the benchmarks of every package with a benchmarks/ folder
devtools_build builds the DevTools extension
docs_bs / docs_build bootstraps and builds the documentation site
update_references propagates package/app references into the READMEs
Setup

The Flutter SDK is pinned with fvm, and the documentation site is a Docusaurus project, so Node.js (with npm) is required too.

fvm install                     # installs the pinned Flutter SDK
fvm dart pub get                # resolves the workspace tools (melos included)
fvm dart run melos bootstrap    # links the packages and prepares the examples
fvm dart run melos run docs_bs  # optional: installs the documentation site (needs Node.js)

Note Melos is a dev_dependency of the root pubspec.yaml, so running it as fvm dart run melos ... is the safest option: you use the melos version pinned by this repository, with the Flutter/Dart SDK pinned by fvm. A globally activated melos (dart pub global activate melos) works as well, but it may be a different version than the one the workspace expects, and the difference usually shows up at the worst possible moment 🙃.

A command is provided to try to publish all packages:

fvm dart run melos publish --dry-run

This ensures that every package is formatted, analyzed, tested and built.

Organization

The repository structure is organized as follows:

workspace/
├── melos.yaml # melos configuration file
├── packages/ # contains every package of the workspace
│   ├── core/ # the CRDT engine and its bindings
│   │   ├── crdt_lf/
│   │   │   ├── lib/
│   │   │   ├── example/
│   │   │   └── flutter_example/
│   │   └── .../
│   ├── adapters/
│   │   └── persistence/ # storage backends for crdt_lf
│   │       ├── crdt_lf_drift/
│   │       ├── crdt_lf_hive/
│   │       └── crdt_lf_sqlite/
│   └── _internal/ # private, unpublished packages
│       ├── benchmark_infrastructure/
│       └── shared_examples_infrastructure/
├── apps/ # contains the applications built on top of the packages
│   └── greyhound_markdown/
│       ├── client/
│       └── server/
├── docs/ # the documentation site (Docusaurus, Node.js project)
├── scripts/ # dart scripts used by the melos commands
└── assets/ # contains the assets used in the documentation
    └── .../
VS Code

If you work with VS Code, the repository already contains a .vscode folder with:

  • the recommended extensions (Dart, Flutter, Melos, Mermaid);
  • the settings (fvm SDK path, project dictionary for the spell checker);
  • the launch configurations for the apps and the examples;
  • the snippets used in the READMEs and the changelogs.

Accepting the recommended extensions gives you the smoothest experience on this workspace.

Contributing

Contributions are welcome: bug fixes, new features, documentation, performance work, or anything else — a fixed typo counts too 💚.

The whole flow (roadmap, issues, pull requests, AI-assisted work) is described in CONTRIBUTING.md. Please read it before opening an issue or a pull request.

Kategorien

Abhängigkeiten

Abhängigkeiten 2 Einträge

Quell-Repository

Projekte, die dieses Paket verwenden

Noch keine Daten verfügbar.