Server for the BookBrainz project

Website • Documentation • Bug tracker

---

This repository contains the code for the BookBrainz web site. The directories are arranged as follows:

• config - the config to be used when running the site; copy the example files and edit, dropping the .example suffix.
• docker - deployment files and configurations
• scripts - scripts used during the development and deployment of BookBrainz.
• sql - PostgreSQL database schemas and migration files—formerly separated in https://github.com/bookbrainz/bookbrainz-sql
• src - node.js source files defining the site logic and user interface.
• static - static files which are served by node as part of the site.
• test - unit tests and functional tests for the site.

Additionally, after building the client JavaScript (see below), the following directories will exist:

• lib - compiled and minified server files
• static/stylesheets - the CSS generated from compiling the project LESS files (src/client/stylesheets).
• static/js - minified JavaScript files which are referred to by the site pages.

Contact and updates

Any questions? You can get in contact with the community on our IRC channel or our forums, or send us an email

Breaking changes to the database schema or our API will be announced on our blog, along with our other major updates, so consider following that.

Contributing

We welcome any and all contributions ! Whether you want to add or improve entries on bookbrainz.org, fix an issue on the website or provide new functionality, we'll be happy to have your help and count you part of our ranks ! If you are new to open source contribution workflows, have a look at this beginner's guide and our contribution guidelines. Looking for existing issues, or to report a new bug you found? Head to our ticket tracker at https://tickets.metabrainz.org/projects/BB ! Still not sure what to start with? Have a look at tickets tagged good-first-bug

Setting up a local BookBrainz server

For instruction on how to set up and configure a local BookBrainz instance, as well as troubleshooting common issues and setting up testing, please visit our developer docs: https://bookbrainz-dev-docs.readthedocs.io

Documentation

The developer documentation can be found at https://bookbrainz-dev-docs.readthedocs.io

We also have a user guide for the website https://bookbrainz-user-guide.readthedocs.io

The inline documentation found in this repository is served alongside on Github Pages: https://metabrainz.github.io/bookbrainz-site

Our contributing guidelines can be found here.

Beta and test subdomains

We have two separate subdomains for the purpose of testing and rolling out beta features. You can sign in with the same account as the one you use on the main website.

beta.bookbrainz.org uses the main database but with a newer version of the code that hasn't been released yet. It is used to test new features.

test.bookbrainz.org: all changes made to this subdomain are not in sync with the main database and vice versa. This domain is for you to tinker with all features of the website freely without having to verify the correctness of the data you enter. This comes in handy if that's all you need to do instead of having to set up BookBrainz locally. This subdomain is used for testing only and the data is not maintained or updated. It is not guaranteed that any of the data will be authentic.