Git Product home page Git Product logo

cm-collab's Introduction

cm-collab

A tiny collaborative Markdown editor based on CodeMirror, communicating with a minimal server and database.

Supports multiple real-time documents, with live cursors. Based on CodeMirror's operational transformation extension. All changes are resolved by server code, fully customizable for needs like authentication and rate limiting. Also, it's designed to be as easy to integrate as possible (read: boring). The backend is stateless and even avoids WebSockets by relying on HTTP/2.

Unlike most toy examples, this application persists data and cleans up database memory. Documents are stored in Postgres, and real-time changes are resolved over Redis, with compaction.

An experiment by Eric Zhang.

Development

Requires Docker Compose and Node.js version 18 or higher.

docker compose up

npm install
npm run dev

Visit http://localhost:6480 in your browser.

Deployment

npm ci
npm run build

export REDIS_URL=redis://...
export DATABASE_URL=postgres://...
npm start

Listens on port 6471 by default, or the PORT environment variable if set.

cm-collab's People

Contributors

ekzhang avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.