Skip to content
forked from usdoj/foia-api

Back-end for the National FOIA Portal

License

Notifications You must be signed in to change notification settings

ameshkin/foia-api-1

 
 

Repository files navigation

DOJ FOIA Project

The DOJ FOIA project's larger purpose is to create a single, unified portal for the submission of Freedom of Information Act (FOIA) requests. This code base's part in that larger goal is to create a Drupal backend which will be accessed by a front-end being developed by 18F.

The backend is currently implemented on the Lightning distro, stealing numerous approaches/configurations from the Reservoir project

BLT

Please see the BLT documentation for information on build, testing, and deployment processes.

Local setup

Follow steps 1-5 from the initial setup section in BLT's docs, as well as 1-3 from the VM steps. Note that you do not need to follow the steps to install npm/nvm on your host machine. If we end up working frontend tasks, these steps can take place within the VM.

VM-related software version suggestions:

  • Virtualbox - 6.0.8
  • Vagrant - 2.2.2
  • Ansible - 2.8.1

Also, be sure to have Vagrant plugins installed:

  • vagrant-auto_network (1.0.3, global)
  • vagrant-exec (0.5.3, global)
  • vagrant-hostmanager (1.8.9, global)
  • vagrant-hostsupdater (1.1.1.160, global)
  • vagrant-share (1.1.9, global)
  • vagrant-vbguest (0.19.0, global)

To export to Word docs via PHPDocX locally:

  • Replace the symlink in docroot/libraries with a downloaded copy of PHPDocX which supports PHP namespaces.
  • Ensure an activated license key is set in the phpdocxconfig.ini file.
  • You may also need to reprovision your environment to ensure that the ZipArchive and Tidy PHP extensions are enabled vagrant reload --provision

Local setup - Docker

As an alternative to Drupal VM, Docker can be used to spin up this project.

  • Install "Docker" and run the "Docker Desktop".
  • From the repo root, run the command "ddev start".
  • Import the database through drush.

Resources

About

Back-end for the National FOIA Portal

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 60.3%
  • Twig 19.2%
  • JavaScript 11.9%
  • Gherkin 7.4%
  • Other 1.2%