Skip to content
This repository has been archived by the owner on May 5, 2022. It is now read-only.

This repository contains all source code for the Vermont File Request Assistant web service.

License

Notifications You must be signed in to change notification settings

mjgaughan/vt-file-request-tool

Repository files navigation

An Algorithmic Assist for Transparency: Streamlining FOIA Requests With a Novel Web Service

Middlebury College, Computer Science CSCI 701 (Fall 2021)

About

Our project provides a web application that—given an appropriate natural language query from the user—will identify the correct State of Vermont department for the user to request relevant public information from. We have implemented this using an instance of the Apache Solr search engine, a Spring Boot API framework, a simple AngularJS front end, as well as some near-term matching for demarcating federal or state jurisdiction.

View our website here!

Usage

Once running, navigate to the frontend interface. Query the searchbar for anything pertaining to state agency records in Vermont. Use the returned information to file a record request to the relevant contact source as provided in the returned information.

Limitations

Currently, this service is limited to the state of Vermont. There is also limited functionality in the demarcation between state and federal agencies.

References

This work was heavily by the following resources:

We also used the following technical references throughout our development:

Building

Requirements:

  • Java 8
  • wget
  • Node 12.18.3
  • Solr 8.1
  • Spring Boot 2.5.5
  • Apache OpenNLP
  • Angular 12.2.10

You'll also need API credentials for Synonyms API.

To run on local, set-up:

  1. Clone Git Repository
git clone https://github.com/mjgaughan/vt-file-request-tool 
  1. Navigate to root Solr directory
  2. Initialize Solr instance
./bin/solr start -e cloud 
  1. Follow prompts, using defaults for nearly everything but instead of 'gettingstarted' name index 'vtstatefiles'
  2. Initialize Solr schema
curl -X POST -H 'Content-type:application/csv' --data-binary '{"add-copy-field" : {"source":"*","dest":"_text_"}}' http://localhost:8983/solr/vtstatefiles/schema
  1. Index CSV file
bin/post -c vtstatefiles ../vtfiles-temp.csv -params "f.genre.split=true&f.directed_by.split=true&f.genre.separator=|&f.directed_by.separator=|"
  1. Navigate to root directory of Spring Boot
$ cd foia-spring-api
  1. Initialize Spring Boot
$ mvn spring-boot:run     
  1. Navigate to root directory of Angular
$ cd ../vt-files-frontend
  1. Initialize Angular front end
$ ng serve
  1. Happy searching!

About

This repository contains all source code for the Vermont File Request Assistant web service.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages