GithubHelp home page GithubHelp logo

web-library's Introduction

web-library

This is zotero.org's web library capable of being installed/run on other websites for a single Zotero library (that is, one user library or one group library).

It is currently limited to the javascript interface. That is the interface most users should see and use, as much of the functionality is unavailable otherwise. Google at a minimum also appears to index the pages after javascript has been executed. Static pages may not, therefore, provide much benefit, and necessitate significantly longer page loads as the api is queried on the server while a browser sees nothing. Fallback static pages would still be desirable, but are not a high priority.

The Zotero API now supports CORS requests so using a PHP proxy to forward requests to the API is only necessary if you need to hide the credentials being used to access the Zotero library. Otherwise a browser only needs to talk to your server for the initial page load.

Installation

  1. Clone git repository into target web directory (git clone --recursive https://github.com/zotero/web-library.git)
  2. run npm install to install dev dependencies
  3. Try out the full library example by generating a config file (examples/reactlibrary/buildconfig.js)
  4. Point browser at the base directory for the example (examples/library/ for the full library)
  5. to build changes (including compiling bootstrap less style) run npm build. For a development build with automatic incremental build on change, use npm start.

Note that to work fully this must be run from a web server because of the limitations on web pages loaded locally. An Apache .htaccess file is included in that directory that will rewrite urls so that the html history api used still works when reloading deeper urls. This would have to be done in different ways on other servers, but only affects reloading the library. The library loaded from the original page should work regardless.

Requirements

  • htaccess with rewrite allowed (For pointing to index.php from any urls in the directory. Without this, reloading or linking to a page other than the base library, eg /baselibrary/itemKey/ASDF1234 will fail)
  • a relatively modern browser

web-library's People

Contributors

tnajdek avatar flachware avatar fcheslack avatar kimisgold avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.