README.md

About / 中文版

This repo contains examples for dragonboat.

The master branch and the release-3.3 branch of this repo target Dragonboat's master and v3.3.x releases.

Go 1.17 or later releases with Go module support is required.

Notice

Programs provided here in this repo are examples - they are intentionally created in a more straight forward way to help users to understand the basics of the dragonboat library. They are not benchmark programs.

Install

To download the example code to say $HOME/src/dragonboat-example:

$ cd $HOME/src
$ git clone https://github.com/lni/dragonboat-example

Build all examples:

$ cd $HOME/src/dragonboat-example
$ make

Examples

Click links below for more details.

• Example 1 - Hello World
• Example 2 - State Machine
• Example 3 - Multiple Raft Groups
• Example 4 - On Disk State Machine
• Example 5 - Optimistic Write Lock

Next Step

• godoc
• Contribute code or report bugs for dragonboat