Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ekzhang/rustpad
Efficient and minimal collaborative code editor, self-hosted, no database required
https://github.com/ekzhang/rustpad
async code-editor collaborative-editing distributed-systems operational-transformation react rust self-hosted tokio typescript
Last synced: 25 days ago
JSON representation
Efficient and minimal collaborative code editor, self-hosted, no database required
- Host: GitHub
- URL: https://github.com/ekzhang/rustpad
- Owner: ekzhang
- License: mit
- Created: 2021-06-01T03:58:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-19T12:20:07.000Z (about 2 months ago)
- Last Synced: 2024-10-01T12:23:26.514Z (about 1 month ago)
- Topics: async, code-editor, collaborative-editing, distributed-systems, operational-transformation, react, rust, self-hosted, tokio, typescript
- Language: Rust
- Homepage: https://rustpad.io
- Size: 294 KB
- Stars: 3,441
- Watchers: 28
- Forks: 148
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - ekzhang/rustpad - Efficient and minimal collaborative code editor, self-hosted, no database required (typescript)
README
# Rustpad
[](https://hub.docker.com/r/ekzhang/rustpad/)
[](https://hub.docker.com/r/ekzhang/rustpad/)
[](https://github.com/ekzhang/rustpad/actions/workflows/ci.yml)
**Rustpad** is an _efficient_ and _minimal_ open-source collaborative text
editor based on the operational transformation algorithm. It lets users
collaborate in real time while writing code in their browser. Rustpad is
completely self-hosted and fits in a tiny Docker image, no database required.
The server is written in Rust using the
[warp](https://github.com/seanmonstar/warp) web server framework and the
[operational-transform](https://github.com/spebern/operational-transform-rs)
library. We use [wasm-bindgen](https://github.com/rustwasm/wasm-bindgen) to
compile text operation logic to WebAssembly code, which runs in the browser. The
frontend is written in TypeScript using [React](https://reactjs.org/) and
interfaces with [Monaco](https://github.com/microsoft/monaco-editor), the text
editor that powers VS Code.
Architecturally, client-side code communicates via WebSocket with a central
server that stores in-memory data structures. This makes the editor very fast,
allows us to avoid provisioning a database, and makes testing much easier. The
tradeoff is that documents are transient and lost between server restarts, or
after 24 hours of inactivity.
## Development setup
To run this application, you need to install Rust, `wasm-pack`, and Node.js.
Then, build the WebAssembly portion of the app:
```
wasm-pack build rustpad-wasm
```
When that is complete, you can install dependencies for the frontend React
application:
```
npm install
```
Next, compile and run the backend web server:
```
cargo run
```
While the backend is running, open another shell and run the following command
to start the frontend portion.
```
npm run dev
```
This command will open a browser window to `http://localhost:5173`, with hot
reloading on changes.
## Testing
To run integration tests for the server, use the standard `cargo test` command.
For the WebAssembly component, you can run tests in a headless browser with
```
wasm-pack test --chrome --headless rustpad-wasm
```
## Configuration
Although the default behavior of Rustpad is to store documents solely in memory
and collect garbage after 24 hours of inactivity, this can be configured by
setting the appropriate variables. The application server looks for the
following environment variables on startup:
- `EXPIRY_DAYS`: An integer corresponding to the number of days that inactive
documents are kept in memory before being garbage collected by the server
(default 1 day).
- `SQLITE_URI`: A SQLite connection string used for persistence. If provided,
Rustpad will snapshot document contents to a local file, which enables them to
be retained between server restarts and after their in-memory data structures
expire. (When deploying a Docker container, this should point to the path of a
mounted volume.)
- `PORT`: Which local port to listen for HTTP connections on (defaults to 3030).
- `RUST_LOG`: Directives that control application logging, see the
[env_logger](https://docs.rs/env_logger/#enabling-logging) docs for more
information.
## Deployment
Rustpad is distributed as a single 6 MB Docker image, which is built
automatically from the `Dockerfile` in this repository. You can pull the latest
version of this image from Docker Hub. It has multi-platform support for
`linux/amd64` and `linux/arm64`.
```
docker pull ekzhang/rustpad
```
(You can also manually build this image with `docker build -t rustpad .` in the
project root directory.) To run locally, execute the following command, then
open `http://localhost:3030` in your browser.
```
docker run --rm -dp 3030:3030 ekzhang/rustpad
```
We deploy a public instance of this image using [Fly.io](https://fly.io/).
## In the media
- **July 11, 2021:** Featured in
[Console 61 - The open-source newsletter](https://console.substack.com/p/console-61).
- **June 5, 2021:** Front-page
[Hacker News post](https://news.ycombinator.com/item?id=27408326). Reddit
discussions in [r/rust](https://www.reddit.com/r/rust/comments/nt4p9f/) and
[r/programming](https://www.reddit.com/r/programming/comments/nt4ws7/).
All code is licensed under the MIT license.
