Get the code

$ cd $GOPATH/src
$ git clone https://github.com/perkeep/perkeep perkeep.org

• Latest changes
• Browse tree
• Open Pull Requests

Making apps that work with Perkeep

Perkeep is built so that other apps can securely access and store data without running alongside it. Perkeep is the perfect backing store for other web apps and CMSes.

Detailed documentation on the HTTP blob retrieval protocol can be found at the protocol documentation. The client, search and schema packages are also a good place to start.

Contributing

• Join the mailing list.

• Pick something that interests you, or look through our list of potential projects for inspiration. Discuss it first, especially if it’s large and/or not well designed yet. You’ll save yourself a headache if someone is already working on something similar or if there’s a more Perkeep-like approach to the issue.

• Sent a Pull Request on GitHub. Expect to make a few changes during the review.

• A bot on GitHub will tell if you haven’t yet signed the Contributor License Agreement.

Documentation

To work on the documentation, you’ll need to locally build and run the server (pk-web) that serves perkeep.org: go install perkeep.org/website/pk-web && pk-web --help. The contents of the website are in the static and content directories under the website directory.