Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 3.04 KB

README.md

File metadata and controls

69 lines (41 loc) · 3.04 KB
Raw

OpenBesluitvorming Search

Search through meeting documents of 140+ Dutch local governments. Powered by Open Raadsinformatie.

Check it out at OpenBesuitvorming.nl!

Using the ORI API

Check out the API docs and the example requests.

Run front-end

  • cd front
  • yarn
  • yarn dev

Run server

  • cd server
  • yarn
  • yarn dev

Run using docker

  • Buid the docker image docker build . -t argu/ori-search
  • ... Or pull it from dockerhub: docker pull argu/ori-search
  • Run it docker run -it -p 8080:8080 -e PORT=8080 argu/ori-search
  • Visit http://localhost:8080

Contribution guidelines

Read contribute.md

Deployment

Semaphore tracks the master branch and deploys succesful builds to a public docker hub repository.

Architecture

The front-end is a search and browse GUI. It's a typescript react application that uses reactiveserach for search components, link-redux for linked data (RDF) resource rendering and react-pdf to display PDF files.

The server is a node express application that serves as both a static file server and a proxy that forward elasticsearch queries to the elastic endpoint of open raadsinformatie.

Re-using OpenBesluitvorming components in your stack

The /front/components/views/ library contains react components that use link-redux to render the data from the Open-Raadsinformatie API. This repo is MIT licensed, so feel free to use these components in your own application. If you need any help during development, please check out the link-redux wiki. Feel free to create an issue or reach out to [email protected].

Connecting with Elasticsearch

Make sure ES has the correct proxy settings.

Credits

  • VNG Realisatie for funding.
  • Open State Foundation for providing useful feedback on this project and starting Open Raadsinformatie.
  • Software developed by Joep Meindertsma from Argu / Ontola.
  • Feedback from @breyten, @aolieman, @fletcher91, @jurrian
  • Various open source projects that we're using, most notably ReactiveSearch and Link-Lib. Check out the package.json files to see which projects were used.
  • @aolieman and Hendrik fpr implementing the Glossary feature (select text in PDF to view definition).

Screen.Recording.2022-12-20.at.12.51.51.mov