Skip to content

CodeWithAloha/froide

 
 

Repository files navigation

UIPA.org

✉️ 🌈 🏢
A Freedom Of Information Portal for the State of Hawaii

Note: This repository works in conjunction with the CodeWithAloha/uipa repository. This repository is the "engine", while the froide repository is the "theme". It is very likely that any work you do will not be in this repository, but in the theme/uipa repository.

Philosophy

Getting information from the government is our right under the Freedom of Information Act, however the process is more opaque than you might expect. The Uniform Information Practices Act 92F (UIPA) is Hawaii's adoption of the FOIA. This portal is a way to help individuals through the process of submitting a FOIA request, as well as open sourcing the requests and responses for others to view - all for free!

News Articles

Development

There are three main things that people have to stand up in order to start developing UIPA. These things are:

  1. The Databases (Elasticsearch & Postgres)
  2. The Backend (Django development server)
  3. The Frontend (vite)

At the end of setting up your development environment, you should have three terminal windows running each of these separately.

The Databases

Prerequisites

Instructions

The databases can be stood up together with one command using the provided docker-compose.yml

After running docker-compose up successfully, the output in your terminal should look something like:

Image

The Backend

Prerequisites

Instructions

To run the Django development server, we need to run the following commands:

# Installing dev-dependencies
pip install -r requirements-test.txt 

# To initialise the database:
python manage.py migrate --skip-checks

# Create a superuser
python manage.py createsuperuser

# Create and populate search index
python manage.py search_index --create
python manage.py search_index --populate

# Run the Django development server
python manage.py runserver

After running these, you should see something like this in your terminal:

Image

The Frontend

Prerequisites

Instructions

# Install the dependencies
yarn install

# Run the front-end server (vite)
yarn dev

After performing these steps, the application should be available at http://127.0.0.1:8000/ and look like:

Image

Attribution

Many thanks to the Open Knowledge Foundation Germany for their work on Froide. Their docs on the project are available here including a Getting Started Guide.

Thanks to the Public First Law Center for providing guidance and hosting for the UIPA.org project.

About

Freedom Of Information Portal

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 69.4%
  • HTML 15.5%
  • Vue 9.2%
  • TypeScript 2.2%
  • JavaScript 2.0%
  • SCSS 1.7%