Giter VIP home page Giter VIP logo

primo-explore-my-ill's Introduction

primo-explore-my-ill

Load illiad requests & articles into Primo "My Account"

Features

Creates a pane in Primo New UI "My Account". Queries ILLiad for user's current requests and received articles, and displays them in the pane, including direct links to articles.

Screenshot

screenshot

Install

  1. Make sure you've installed and configured primo-explore-devenv.

  2. Navigate to your template/central package root directory. For example:

    cd primo-explore/custom/MY_VIEW_ID
    
  3. If you do not already have a package.json file in this directory, create one:

    npm init -y
    
  4. Install this package:

    npm install primo-explore-my-ill --save-dev
    
  5. Generate an ILLiad Web Platform API Key, as described here.

  6. Deploy the php file to a server accessible to you. Edit lines 7, 10, and 11.

  7. Place the .htaccess file in the same directory as your PHP file to add CORS authorization. Note: if CORS is still an issue, please visit this page for further solutions to get this working.

Usage

Once this package is installed, add my-ill as a dependency for your custom module definition.

var app = angular.module('viewCustom', ['myILL'])

Note: If you're using the --browserify build option, you will need to first import the module with:

import 'primo-explore-my-ill';

You can configure the banner by passing a configuration object. All properties are required.

name type usage
groups array array of alma user group codes in which this should appear
remoteScript string url of server-side php script
boxTitle string Text to appear at the top of the ILL box
illiadURL string url of your ILLiad login page
apiURL string url of ILLiad Web Platform endpoint for Transactions/UserRequests (documentation here)

The code below adds a banner similar to the above image.

app.constant('illiadOptions', {
  "groups": [0,1,2,3],
  "remoteScript": "https://mydomain.com/illiad.php",
  "boxTitle": "My Library Interlibrary Loan",
  "illiadURL": "https://illiad.myinstitution.edu/illiad/Logon.html",
  "apiURL": "https://illiad.myinstitution.edu/ILLiadWebPlatform/Transaction/UserRequests/",


})

primo-explore-my-ill's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

primo-explore-my-ill's Issues

Add tests

  • add testing dependencies
  • write tests
  • add travis

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.