Python HTML CSS JavaScript Shell Makefile Other
Switch branches/tags
Clone or download
mekarpeles Merge pull request #1049 from internetarchive/hotfix/ol-infogami-page…
…-css-navfix

fixing infogami navigation styling so its inline without discs
Latest commit 5633e5d Aug 7, 2018
Permalink
Failed to load latest commit information.
beta/static/styles (WIP) Saving feature/survey branch in progress Jul 14, 2017
conf [1028/refactor/ipstats] remove references to counts_db config Jul 18, 2018
openlibrary use xauthn service param, have archive.org activation redir to OL (#1038 Jul 27, 2018
provisioning Merge pull request #985 from cdrini/refactor/remove-couchdb-remnants Jun 26, 2018
scripts fixing date str formatter to ref correct nginx log file Jul 28, 2018
static fixing infogami navigation styling so its inline without discs Aug 6, 2018
tests Add basic manual screenshot testing Jul 7, 2018
vendor adding all slick dependencies Dec 6, 2017
.gitattributes Add .gitattributes & normalize line endings Apr 5, 2017
.gitignore Merge pull request #985 from cdrini/refactor/remove-couchdb-remnants Jun 26, 2018
.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
CONTRIBUTING.md Deorecated code.openlibrary.org and removed the docs folder from the … Apr 12, 2018
LICENSE add LICENSE Jul 16, 2007
Makefile [refactor/remove-unused-requirements] remove sphinx/docs Jun 15, 2018
PULL_REQUEST_TEMPLATE.md Pull Request Template Added Mar 10, 2018
Readme.md Deorecated code.openlibrary.org and removed the docs folder from the … Apr 12, 2018
Vagrantfile [hotfix/update-vagrant-to-xenial] ensure ol-start runs when vagrant r… Jun 3, 2018
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 mving amazon pkg to common for tests Jul 21, 2018
requirements_common.txt mving amazon pkg to common for tests Jul 21, 2018
setup.py Merge pull request #985 from cdrini/refactor/remove-couchdb-remnants Jun 26, 2018
setup.sh fix typo in setup.sh documentation Feb 6, 2013
test_requirements.txt factoring common requirements into own requirements_common.txt Jul 21, 2018

Readme.md

Open Library

Build Status Join the chat at https://gitter.im/theopenlibrary/Lobby

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

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 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 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). Kindly look up on our Testing Document for more details

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

Check out our contributor's guide to learn how you can contribute!

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.