Contributing
Last updated
Was this helpful?
Last updated
Was this helpful?
Join our community on or other .
If your version of Go < 1.13, you need to run:
Follow the instructions for running Cayley locally:
packr2
go build ./cmd/cayley
Give it a quick test with:
To run the web frontend, replace the "repl" command with "http"
If your version of Go < 1.13, you need to run:
If you just want to build Cayley and check out the source, or use it as a library, a simple go get github.com/cayleygraph/cayley will work!
But suppose you want to contribute back on your own fork (and pull requests are welcome!). A good way to do this is to set up your $GOPATH and then...
...where $GITHUBUSERNAME is, well, your GitHub username :) You'll probably want to add
So that you can keep up with the latest changes by periodically running
With that in place, that folder will reflect your local fork, be able to take changes from the official fork, and build in the Go style.
For iterating, it can be helpful to, from the directory, run
Which will also resolve the relevant static content paths for serving HTTP.
Reminder: add yourself to CONTRIBUTORS and AUTHORS.
If your version of Go < 1.13, you need to run:
First, cd into the cayley project folder and run:
If you have a Docker installed, you can also run tests for remote backend implementations:
If you have a Docker installed, you only want to run tests for a specific backend implementations eg. mongodb
Integration tests can be enabled with environment variable:
You can now open the WebUI in your browser:
First, you'll need Go and a Go workspace. This is outlined by the Go team at and is sort of the official way of going about it.