Skip to content

MattiaPispisa/crdt

Repository files navigation

CRDT

github_starts melos_badge repo_size

logo

docs_badge

Packages

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. Consistency is granted by the melos tool.

To setup the workspace, run:

melos bootstrap

A command is provided to publish all packages:

melos publish --no-dry-run --git-tag-version

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
│   ├── crdt_lf/
│   │   ├── lib/
│   │   ├── example/
│   │   └── flutter_example/
│   └── .../
│       ├── lib/
│       ├── example/
│       └── flutter_example/
└── assets/ # contains the assets used in the documentation
    └── .../

Contributing

We welcome contributions! Whether you want to:

  • Fix bugs
  • Add new features
  • Improve documentation
  • Optimize performance
  • Or something else

Feel free to:

  1. Check out our GitHub repository
  2. Look at the open issues
  3. Submit a Pull Request