RaadsTalk

March 12, 2020 ยท View on GitHub

License: MIT

A webapplication that uses Open Raadsinformatie to show which topics are being discussed in Dutch municipalities. Uses the WeighWords library / Parsimonius algorithm to calculate which words are trending.

Check it out at VNG Realisatie or at raadstalk.nl!

Use as widget

Add this iFrame to your webpage:

  <iframe src="https://raadstalk.nl/widget" height="100%" width="100%" frameborder="o" scrolling="no">
    Raadstalk kan niet worden geladen. Bezoek <a href="https://raadstalk.nl">raadstalk.nl</a>
  </iframe>

Put it inside a wrapping element that constrains its width (about 250px) and height (about 400px).

See an example HTML file here.

Managing Topics

  • Visit admin.localhost (or admin.raadstalk.nl in production) and login using your credentials. The password is set with the secret.env file.
  • Manage months and their items by adjusting raadstalk.YYYY-MM. You can remove items from the lists.
  • Blacklist words / words to ignore can be set by adding items to raadstalk.stupid_words. Be aware that the /opt/trends/es_dump folder within the container should be flushed when new words are added.
  • Create backups by exporting the redis data and pasting the content to a new .redis file in the ./backups folder. You can import these using the same interface.

Setup

  • Get docker and docker-compose
  • Setup the secret cp secret_template.env secret.env
  • Change the password vim secret.env
  • Setup the environment variables in server folder cd server && cp template.env .env
  • Add blacklisted words using redis admin admin.localhost. Import the stupid_words.redis file.

Local development

  • ./dev.sh
  • Visit http://localhost
  • Redis admin is available at http://localhost:8888 or http://admin.localhost
  • If you use VSCode, you can use the Debug server build task

Tasks

  • docker-compose up -d nginx for running the server.
  • Adjust variables.env to set start date.
  • docker-compose up --build trends for running trends task to update the words
  • docker-compose up --build countall for updating trends task to update all counts
  • docker-compose up --build countlastmonth for updating trends task to update last months counts

Deployment & devops

  • Follow steps from setup
  • For HTTPS, use ./init-letsencrypt.sh. Check this tutorial for more information.
  • Download the latest version and restart docker-compose ./renew.sh
  • Don't forget to periodically run trends crontab ./cronjob

Credits

Funded by VNG Realisatie B.V.

Development by Joep Meindertsma (@joepio) & Jurrian Trom (@jurrian) from Ontola / Argu B.V.

License

MIT