FAQs

Frequently Asked Questions (FAQs)

Getting Started

• How do I set up the Open Library app locally?
  • What process should I follow if I encounter a problem when building with docker?
• How do I find, claim, and work on a good first issue?
  • What git conventions does the project follow?
  • How do I submit a good pull request?
• How can I debug when things go wrong?
• How do I import production book & author data into my local environment?
• How can I login as a user in my local environment?
• How do I create and activate new accounts locally?
• How do I add a new route to Open Library? (tutorial)
• How do I add new Javascript functionality to a template?
• How do I find the right CSS file to add style rules?
• How do I rebuild css & js assets after I make changes?

Debugging & Testing

• How do I manually test whether a python function I've written works as expected?
• How do I write tests?

Understanding the Application

• How does routing work on Open Library?

Understanding the Codebase

• Where do I find data models, template files (views), and routers (controllers)?
• How are controllers/routers organized?
• Where can I see an overview of what routes exist and what they do?

Understanding the Tech

• How does an infogami + webpy application work (overview)?

Librarian Resources

• How do I register new book identifier types in Open Library?

Design

• Where do I find Open Library's design system?