Skip to content
beta release software
JavaScript CSS HTML Ruby
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client
server
.DS_Store
.gitignore
CI Documentation Beta.pdf
LICENSE
README.md
Server Documentation Beta.pdf
package-lock.json

README.md

Citing Insights

A powerful web application designed to streamline assessment of students' information literacy and other skills. With Citing Insights, you can easily upload a student papers, the citations are detected and links to discovery tools make it easy to evaluate the sources. Discovery tools include Semantic Scholar, Google Scholar, and a Library's Alma Primo. Citing Insights is designed to automate using or editing AAC&U Information Literacy Value Rubrics, and other assessment rubrics, for assessing the student papers. You can also add annotation, and provide students feedback, or provide accrediting bodies with detailed assessment reports. Screenshot of Citing Insights Analyze user interface

Table of Contents

Version

Beta

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

 [sudo] apt-get install ruby-full
[sudo] gem install anystyle-cli

Installing

A step by step series of examples that tell you how to get a development env running

Step 1: Navigate to the client directory and install dependencies
cd citing-insights-beta
cd client
npm install
Step 2: Navigate to server directory and install dependencies
cd ..
cd server
 npm install
Step 3: Obtain Google API Credentials

Citing Insights requires Google to log in and out of the application. In order for the Citing Insights log in to work for your institution, you need to obtain Google API Credentials.

To obtain credentials go to console.developers.google.com, create a new project, and enable (it is free, but it requires a credit/debit card to register) to both Google Analytics API and Identity Toolkit API.

Be sure to click the Credentials tab on the left and set the correct Redirect URI’s, as instructed by Google.

Step 4: Add Credentials to Application

Create a config.js file in the server directory and place 'clientID' and 'clientSecret' information with your Google Credentials, keep the quotes.

module.exports = {
   'googleAuth': {
       'clientID': '',
       'clientSecret': ''
   }
};

Similarly, navigate to /client/src/ create a config.json file and place your ClientID into the empty field.

{
   "GOOGLE_CLIENT_ID": ""
}
Step 5: Launch App Locally

To start the application locally and in development mode, from a Linux or Linux based terminal navigate to the server directory and type

npm run dev

This will launch the server at http://localhost:5000, and the client (React application) at http://localhost:3000

Notes:

At any point, if you wish to stop the application type CTRL + C in the active terminal.

This configuration is running nodemon, which allows for the server to restart any time it detects a change in a file (hot reloading). So, no need to bring down and bring up the server each time a change is made to a file, simply saving the file suffices.

Deployment

For additional information on how to launch on a Linux server see our Server Documentation

Known Issues

To be resolved with Version 1.0.

  • Manage Coursework
    • Assignments are slow to appear
    • Papers are not deleted
  • Upload
    • Upload feedback too fast for user to see
    • Application crashes when class and assignment are not selected
  • PDF viewer
    • PDF Search Tool does not bring user to desired location on the paper
    • Highlighted text color does not change when iterating through list
    • PDF text font and size changes upon text selection
    • Viewer slower on large documents with many pages
    • Zoom out justifies left leaving large grey space
  • Overview
    • If page was visited before and user goes back to analyze and to make more assessments or changes, then the page will have to be refreshed upon return.

Rubrics

Version 1.0 Features

Citing Insights Version 1 release is expected in the end of May, and the planned features include:

  • Enhanced PDF Search functionality
  • Multiple evaluators mode, with inter-reliability testing / norming, and analytics
  • Robust analytical reports & outcomes
  • Group Administration Console
  • Robust rubric resources
  • More Improvements to Design
  • Integration roadmap with Learning Management System.

Built With

Contributing

This is an open source project and we encourage anyone to build upon this outstanding achievement, as long as the intent is good. That being said, the authors will not be responsible for maintaining this project. Citing Insights will focus development on student features next year, if available funding is provided.

Authors

Project Sponsor

License

This project is licensed under the MIT License

Acknowledgments

A big thank you to our alpha and beta testers!
Sue Armitage, Joan Berman, Victoria Bruner, Josh Callahan, Adam Carter, Jim Graham, Chris Guillen, Sally Hang, Julia Heatherwick, Alison Holmes, Katia Karadjova, Cyril Oberlander, Jeremy Shellhase, Meghann Weldon, Joshua Zender, and everyone at the Humboldt State University Library. Also a big thank you to the Graduation Initiative 2025 from California State University, and Humboldt State University for their support of this project. HSU Library provide project based learning opportunities to solve challenges faced by higher education and the community at large. One of the key questions for Citing Insights is how can we make assessment easier.

User Guide

A quick guide was developed by the Citing Insights team to assist users.

You can’t perform that action at this time.