One webpage for every book ever published!
Python HTML CSS JavaScript XSLT Shell Other
Latest commit 3e42b5e Feb 16, 2017 @mekarpeles mekarpeles committed on GitHub Merge pull request #419 from internetarchive/hotfix/user-email-banner…
…-fix-redirect

Adding blacklist of urls not to redirect back to, e.g. forgot password
Permalink
Failed to load latest commit information.
conf adding analytics tracking to linking flows Feb 9, 2017
couchapps removing trailing whitespace from html and py files Oct 21, 2016
docs removing trailing whitespace from html and py files Oct 21, 2016
openlibrary Adding blacklist of urls not to redirect back to, e.g. forgot password Feb 16, 2017
provisioning tweaks to bootstrap script. Jun 20, 2014
scripts updating sitemap to remove editions and include full slug Nov 15, 2016
static Responding to PR feedback in #418 (comment) Feb 16, 2017
tests/integration Fixed case sensitivity with emails via IA xauth API. Updates login pa… Feb 14, 2017
vendor added docs which explain why we changed vendor code Jan 20, 2017
.gitignore Add .cache to .gitignore Sep 2, 2016
.gitmodules Moved infogami and wmd to internetarchive. Jul 1, 2011
.python-version Add .python-version (can be used by pyenv) Jul 26, 2016
.travis.yml tidy up commented out legacy commands Jan 18, 2016
LICENSE add LICENSE Jul 16, 2007
Makefile Make Edition can_borrow() check whether IA item is in private collection Dec 13, 2016
Quickstart.md fixing olsystem link Nov 15, 2016
Readme.md Updating READMEs Nov 15, 2016
Vagrantfile mount OL code at /openlibray on vm. Nov 25, 2014
config Make the support structure a little more robust Jun 21, 2011
infogami Reorganized the repo to move all python code into openlibrary module. Jul 8, 2009
requirements.txt Working OL b/e flow Jan 24, 2017
setup.py Removed obsolete setup_commands.py code. Jan 6, 2015
setup.sh fix typo in setup.sh documentation Feb 6, 2013
test_requirements.txt Working OL b/e flow Jan 24, 2017

Readme.md

Open Library

Open Library (https://openlibrary.org) is an open, editable library catalog, building towards a web page for every book ever published.

Build Status

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.

Installation

First you need to have installed Virtualbox and Vagrant.

Next, fork the OpenLibrary repo to your own Github account and clone your forked repo to your local machine:

    git clone git@github.com:YOURACCOUNT/openlibrary.git

Enter the project directory and provision + launch the dev virtual machine instance using vagrant:

  cd openlibrary
  vagrant up

You can now view your running instance by loading http://localhost:8080 in a web browser.

You can turn off the virtual machine from the host machine using:

    vagrant halt

To administrate and ssh into the vagrant dev virtual machine, type:

    vagrant ssh

Note: Remember that, thanks to vagrant and virtual box, your local folder openlibrary (where you ran vagrant up) contains exactly the same files as /openlibrary in the dev virtual machine (the one that you login to via vagrant ssh).

Help!

If running in Vagrant, but services don't seem to have been properly started -- e.g. the site works but you can't login with the default credentials -- try running vagrant up --provision.

Developer's Guide

For instructions on administrating your Open Library instance and build instructions for developers, refer the Developer's Quickstart.md document.

You can find more info digging into this old (and in part outdated) document here: http://code.openlibrary.org/en/latest/

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 Frontend

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):

The Service Architecture

Running tests

Open Library tests can be run using pytest (py.test).

Inside vagrant, go to the application base directory:

    cd /openlibrary
    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

Contributing

We'd love your help! Choose a bug from our project board: https://github.com/internetarchive/openlibrary/projects/1

License

All source code published here is available under the terms of the GNU Affero General Public License, version 3. Please see http://gplv3.fsf.org/ for more information.