GitHub - internetarchive/openlibrary: One webpage for every book ever published!
source link: https://github.com/internetarchive/openlibrary
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Readme.md
Open Library
Open Library is an open, editable library catalog, building towards a web page for every book ever published.
Table of Contents
- Overview
- Installation
- Code Organization
- Architecture
- Developer's Guide
- Running Tests
- Contributing
- Public APIs
- FAQs
- License
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 [email protected]: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
).
Reload vagrant services:
- From within vagrant restart the Open Library service via:
sudo systemctl restart ol-web.
- If you are not in the vagrant dev virtual machine you can simply run
vagrant reload
for the same.
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 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):
Running tests
Open Library tests can be run using pytest. 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
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK