boydog-demo

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

You can use this repository as your starting boilerplate for your real-time collaborative projects.

Status: Fully working beta

Running this demo

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

For a minimal, bare-bones boilerplate see: https://github.com/boydoglabs/boydog-demo-minimal

Realtime directives

• dog-value: Binds <input> value.
• dog-html: Bind element inner HTML.
• dog-id: Bind tag id
• dog-class: Bind tag classes

Examples:

• <input dog-value="editor">
• <p class="alert" dog-html="alertInfo"></p>
• <p dog-class="alert.class" dog-html="alert.info"></p>

See more examples at the demo page.

BoyDog monitor

BoyDog automatically creates a route to monitor all changes users make. Browse the boydog-monitor at the URL provided in the console log when you run npm start. This allows you to monitor user's input real-time. It has admin privileges and changes made through this page will be sent to connected users.

Contributing

There are 3 main repositories:

• boydog: The server module, handles OT, auth, and creates the boydog-monitor.
• boydog-client: The client module, handles OT for the users, is in charge of updating HTML elements with the latest value from the server.
• 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, therefore if you want to start a new project or develop a new feature just clone this repository.

And a shareDB plugin:

• sharedb-attribute-binding: A custom-made ShareDB binding that allows you to sync element attributes like id, class, href, etc.

All these modules can be found inside the "git_modules" of this repo. To help you do changes easily do npm run dev to install these modules and automatically restart server on file changes.

Running tests

First run the server with npm start or npm run dev if you are developing a new feature. Then run e2e tests with npm run test.

License

[MIT] © boy.dog