mono

KO | EN

gitlite — search

#python #react #javascript #hacktoberfest #api #typescript #hacktoberfest-accepted #hacktoberfest2022 #python3 #minecraft #nft #css

★ 59 Open GitHub ↗

Collaborative and distributed Markdown text editor, started as a bachelor thesis project at HEIG-VD.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![License](https://img.shields.io/badge/license-MIT-green)](https://opensource.org/licenses/MIT)

[![.github/workflows/frontend.yml](https://github.com/markdown-party/mono/actions/workflows/frontend.yml/badge.svg?branch=main)](https://github.com/markdown-party/mono/actions/workflows/frontend.yml)
[![.github/workflows/backend.yml](https://github.com/markdown-party/mono/actions/workflows/backend.yml/badge.svg?branch=main)](https://github.com/markdown-party/mono/actions/workflows/backend.yml)
[![.github/workflows/tests.yml](https://github.com/markdown-party/mono/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/markdown-party/mono/actions/workflows/tests.yml)

[![.github/workflows/dokka.yml](https://github.com/markdown-party/mono/actions/workflows/dokka.yml/badge.svg?branch=main)](https://markdown-party.github.io/mono/)

# Welcome to :rainbow: [markdown.party](https://markdown.party/) :rainbow:

`markdown-party/mono` is a distributed collaborative Markdown editor, based on a replicated log of
events. Multiple abstractions are implemented, which replicate events on multiple sites. The project
makes heavy use of [Kotlin coroutines](https://kotlinlang.org/docs/coroutines-guide.html), to allow
non-blocking concurrent communications with many replicas. It implements some tree-like and sequence
CRDTs to replicate its state.

![Markdown Party](https://raw.githubusercontent.com/markdown-party/mono/main/assets/hero.png)

## Library and project walk-through

The library documentation can be found on [GitHub Pages](https://markdown-party.github.io/mono/).

> Many snippets from the walk-through can be found in the `samples/walkthrough` module. Make sure to
> check them out and run them on your machine, to get a feel of how the library works !

### Project walk-through

1. [Introduction and basics](library/echo/README.md)
2. [The low-level event log API](library/echo-core/README.md)
3. [Integrations and websockets](library/echo-ktor-websockets/README.md)
4. [Example : adding a move operation for cursors](markdown/markdown/README.md)

## Local setup

This project uses Kotlin 1.6.21 and is built with [Gradle](https://gradle.org). To run the unit
tests locally, please proceed as follows :

```bash
# Clone the repository locally.
> git clone git@github.com:markdown-party/mono.git && cd mono

# Run Gradle tests.
> ./gradlew check

# Run the markdown editor frontend and backend. You'll have to edit the configuration in the
# file "markdown/markdown-frontend-compose/src/jsMain/resources/config.js" to point to your localhost
# rather than the production server.
> ./gradlew markdown:markdown-backend:run
> ./gradlew markdown:markdown-frontend-compose:jsBrowserRun

# Alternatively, if you have Docker Compose installed, you can run both the backend and the frontend
# locally as follows :
#
# > ./run-local.sh
#
# The frontend will be available on http://localhost:8080, and the backend on http://localhost:8081.
```

## Cheat sheet

Here's how you should use the project :

| Use-case                                                    | Relevant module(s)                               |
|-------------------------------------------------------------|--------------------------------------------------|
| I want to use a Markdown editor.                            | Go to [markdown.party](https://markdown.party) ! |
| I want to replicate Markdown / Trees, but don't want a GUI. | `markdown`, `echo`, (`echo-core`)                |
| I want to create a custom CRDT and replicate it.            | `echo-ktor-xxx`, `echo`, (`echo-core`)           |
| I only need a log of events which computes an aggregate.    | `echo-core`                                      |

## About

I'm developing this project as part of my Bachelor thesis at HEIG-VD. If, like me, you like
distributed systems, Kotlin, coroutines or reactive UI frameworks, I'd love to hear from you
at [alexandre.piveteau@alumni-heig-vd.ch](mailto:alexandre.piveteau@alumni-heig-vd.ch) :v:

mono

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README