Skip to content

BoyDog is a framework for building ultra-fast, real-time collaborative web applications.

Notifications You must be signed in to change notification settings

boydoglabs/boydog-demo

Repository files navigation

boydog-demo

contributions welcome Build Status GitHub license Maintenance

BoyDog is a framework for building ultra-fast, real-time collaborative web applications. BoyDog uses ShareDB's OT (operational transformation) to keep data consistent even if multiple users are editing the same text at the same time. You can use this repository as your starting boilerplate for your real-time collaborative projects.

Demo: www.boy.dog.

Getting started

See instructions at boydog demo

Running this demo

  • git clone https://github.com/boydoglabs/boydog-demo
  • npm install
  • npm start
  • Browse localhost:3090 from two different computers.

Running e2e tests

Do npm run test. Make sure the project is already running at 3090.

Contributing

  • boydog: The server module, handles OT, auth, and creates the boydog-monitor.
  • boydog-demo (this repository): A demo showcasing all BoyDog capabilities. This is what you see at boy.dog. For simplicity all development is also made here. If you want to start a new project or develop a new feature clone this repository.
  • sharedb-attribute-binding: A custom-made ShareDB binding that allows you to sync element attributes like id, class, href, etc.

License

[MIT] © boy.dog

About

BoyDog is a framework for building ultra-fast, real-time collaborative web applications.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published