UI to enable analysts to quickly assess changes to monitored government websites
This repository is part of the EDGI Web Monitoring Project.
This component works with web-monitoring-db and web-monitoring-processing to support the next web monitoring workflow.
It’s a React.js-based browser application with a Node.js backend with the following capabilities:
Install Node 18.12.1
nvm install 18.12.1
Install node dependencies with
.env and supply any local configuration info you need (all fields are optional)
Start the web server!
…and point your browser to http://localhost:3001 to view the app. If you haven't changed
WEB_MONITORING_DB_URL in your
.env file (step 3), you can log in with the public user credentials:
To run all tests once
while to start the test runner in watch mode
npm run test-watch
Access the main view at
This repository falls under EDGI's Code of Conduct.
We need your help! Please read through the Web Monitoring Project project document and see what you can help with and check EDGI’s contribution guidelines for information on how to propose issues or changes.
You can also run this project via Docker. To build and run (on port 3001, as in the instructions for running directly above):
docker build -t envirodgi/ui . docker run -p 3001:3001 -e <ENVIRONMENT VARIABLES> envirodgi/ui
Point your browser to
To run tests via Docker:
docker build -t envirodgi/ui:dev --target dev . docker run envirodgi/ui:dev npm run test
New releases of the app are published automatically as Docker images by CircleCI when someone pushes to the
release branch. They are availble at https://hub.docker.com/r/envirodgi/ui. See web-monitoring-ops for how we deploy releases to actual web servers.
Images are tagged with the SHA-1 of the git commit they were built from. For example, the image
envirodgi/ui:6fa54911bede5b135e890391198fbba68cd20853 was built from commit
We usually create merge commits on the
release branch that note the PRs included in the release or any other relevant notes (e.g.
This project wouldn’t exist without a lot of amazing people’s help. Thanks to the following for all their contributions!
|📖 📋 💬 👀||Dan Allan|
|📋 🔍||Andrew Bergman|
|💻 📖 💬 👀||Rob Brackett|
|💻 ⚠️||Nick Echols|
|💻 ⚠️||Katie Jones|
|💻 ⚠️||Greg Merrill|
|💻 🎨 📖 💬 👀||Kevin Nguyen|
|💻 ⚠️||Johnson Phan|
|📖 📋 📢||Matt Price|
|📋 🔍||Toly Rinberg|
|📖 📋||Dawn Walker|
|💻 📖 ⚠️ 👀||Sarah Yu|
|💻 ⚠️||Alberto Zaccagni|
(For a key to the contribution emoji or more info on this format, check out “All Contributors.”)
Copyright (C) <2017> Environmental Data and Governance Initiative (EDGI) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.0.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
LICENSE file for details.