Welcome to the BookBrainz Developer Docs!

This documentation is intended to act as a guide for developers working on or with the BookBrainz project, describing the system, its modules and functions.

For a description of BookBrainz and end-user oriented documentation, please see the BookBrainz User Guide.

Contents of this documentation

• Installation
  • Setting Up
  • Docker Installation
  • Manual Installation
  • Search server setup
  • Advanced Users
  • Testing
• Coming from MusicBrainz
  • Entities
  • Versioning
  • Aliases
  • Sets
  • Merging
• BookBrainz Schema
  • Introduction
  • Overview
  • Revisions
  • Entity data
  • Author credits
• BookBrainz ORM
  • Overview
  • Entities and their revisions
  • Entities and their data
  • Transactions
• BookBrainz Webservice/API
• The Entity Editor
  • Introduction
  • Different sections of the Entity Editor
  • Adding an Entity
• The Unified Form
  • Introduction
  • Overview
  • Redux Store
  • Summary Tab
• Troubleshooting
  • General
  • Elasticsearch
  • Redis
  • PostgreSQL
  • Node/npm/yarn
• Entity Editor Seeding
  • Generic Sections
  • Entity Specific
  • Example Submission

Our repositories

Our codebase is divided in a few repositories:

• bookbrainz-site:the main repository for the website and API

• bookbrainz-data-js: the ORM package we use to interface with the database

• bookbrainz-dev-docs: these very same docs you’re reading !

• bookbrainz-user-guide: the user-facing guide for using the website

• bookbrainz-utils: database tools and scripts