React web application with a PHP backend for the purpose of searching through Perpetual Access Rights data

License: GNU General Public License v3.0

HTML 1.37% JavaScript 52.38% CSS 0.06% PHP 46.19%

library-journal-entitlements-project's Introduction

Library Journal Entitlements Project

For a complete overview of the project and presentation links about it please refer to the wiki.

This project is licensed under GPLv3. See LICENSE.

Overview

Many academic libraries subscribe to several packages of electronic journals to which it is given "perpetual access rights" (PAR) to each journal title for each year it subscribes. Often, library staff and sometimes even patrons need to be able to quickly determine if a particular year of a particular journal is "owned" (perpetual rights even after cancellation) by the institution. They might look for it by its title or one of its two "ISSN" numbers (print and online).

A central organization called CRKN manages many of these subscriptions/licenses for its members. CRKN has recently started creating spreadsheets that include for each member the "entitlement" list of what titles/years that institution has PAR for.

Each package has a separate spreadsheet file - there are about 10 or so of these from CRKN.

Each spreadsheet has all of the data for all approximately 75 members, of which each CRKN member institution is one "column" in one of the tabs. They are all in exactly the same format, just different data for different publisher-packages.

The spreadsheets are updated a couple of times per year each and are made available on a public website managed by CRKN.

The goal of this project is to create a public-facing web front end that each institution can easily copy/configure to just their own PAR, to:

generate a report by package/title/year of all entitlements
allow the website user to search through all of the spreadsheets by title or issn to find all of the PAR years that institution has

library-journal-entitlements-project's People

Contributors

Stargazers

Watchers

Forkers

jordanpedersen

library-journal-entitlements-project's Issues

Server: setup starter search endpoint

At this point just return some dummy data

Implement wireframe design

Server: create endpoint that returns list of all files

Set up endpoint that returns links to download CRKN excel files

Refine wireframes

Create frontend wireframes

Each member creates wireframes of front end of what they envision. Come together after too discuss.

Research security/authentication best practices

Create Initial React project

Create list of search questions

Create a list of questions to ask Melissa (the client) regarding search functionality to get a better understanding of how it will work.

question list

Utilize Server account to get Graph Access token

Walk through docs here: https://docs.microsoft.com/en-us/graph/auth-v2-service in order to get a Graph access token without user needing to authenticate.

Deliverable: Get access token without consent and utilize to get data.

Add Prettier documentation

Prettier is a code formatter that works with most frontend languages. It is used to keep the look of code consistent across multiple developers.

Frontend: Call files endpoint

Call files endpoint to get links to download files.

Intro to React

Learn a bit about React by completing this demo project:

https://reactjs.org/tutorial/tutorial.html

PHP script to screen scrape URL from CRKN

Set up initial design of website

Setup SQLite Test database

Test out using SQLite and create an initial test db with data.

Convert spreadsheet data to match db schema

Frontend: Call search endpoint

Add button/link to admin page

Research into Graph access tokens

Figure out how we can acquire access tokens without the users needing to login every time.

Create SQLite tables

create the SQLite tables we will use to store PAR data.

Frontend: Display dummy search result data

Nothing fancy for now, just display the mock data currently being returned by the server.

Setup /admin-setup route

this route will get called when user navigates to "/admin" on frontend. Will return whether or not admin account is setup.

if(accountSetup) show login stuff
else show account setup stuff

Rethink solution

Document SQLite

Document how the project uses SQLite and the steps necessary to get it working in the local dev environments

Set up test API endpoint and connect to frontend

Setup admin file in backend

Setup file in backend to store admin data.

Design flow for how updating DB will work

Figure out how the database will be updated when new files are added, how updates will work, how wiping the db will work, etc.

Setup simple search query on DB

Simple query endpoint that for now just accepts a query string with no advanced filters/options.

Frontend: Display links to download files

Decide on SQLite Table schema

Figure out the schema we will use to store data. Main concern is how we will keep track of each school.... maybe we don't track each school in the database.