Skip to content

Latest commit

 

History

History
95 lines (62 loc) · 5.15 KB

Readme.md

File metadata and controls

95 lines (62 loc) · 5.15 KB
Raw

Open Library

Python Build JS Build Join the chat at https://gitter.im/theopenlibrary/Lobby Open in Gitpod

Open Library is an open, editable library catalog, building towards a web page for every book ever published.

Are you looking to get started? This is the guide you are looking for. You may wish to learn more about Google Summer of Code (GSoC)? or Hacktoberfest.

Table of Contents

Overview

Open Library is an effort started in 2006 to create "one web page for every book ever published". It provides access to many public domain and out-of-print books, which can be read online.

Here's a quick public tour of Open Library to get you familiar with the service and its offerings (10min).

archive org_embed_openlibrary-tour-2020 (1)

Installation

Run docker-compose up and visit http://localhost:8080

Need more details? Checkout the Docker instructions or video tutorial.

Alternatively, if you do not want to set up Open Library on your local computer, try Gitpod! This lets you work on Open Library entirely in your browser without having to install anything on your personal computer. Warning: This integration is still experimental. Open In Gitpod

Developer's Guide

For instructions on administrating your Open Library instance, refer to the Developer's Quickstart Guide.

You can also find more information regarding Developer Documentation for Open Library in the Open Library Wiki.

Code Organization

  • openlibrary/core - core openlibrary functionality, imported and used by www
  • openlibrary/plugins - other models, controllers, and view helpers
  • openlibrary/views - views for rendering web pages
  • openlibrary/templates - all the templates used in the website
  • openlibrary/macros - macros are like templates, but can be called from wikitext

Architecture

The Backend

OpenLibrary is developed on top of the Infogami wiki system, which is itself built on top of the web.py Python web framework and the Infobase database framework.

Once you've read the overview of OpenLibrary Backend technologies, it's highly encouraged you read the developer primer which explains how to use Infogami (and its database, Infobase).

If you want to dive into the source code for Infogami, see the Infogami repo.

Running tests

Open Library tests can be run using pytest. Kindly look up on our Testing Document for more details.

Run tests while the docker container is running.

cd docker/
docker-compose exec web make test

Integration Tests

Integration tests use the Splinter webdriver with Google Chrome. For instructions on installation requirements and running integration tests, see Integration Tests README.

License

All source code published here is available under the terms of the GNU Affero General Public License, version 3.