web-monitoring-ui

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 and Typescript-based browser application with a Node.js backend with the following capabilities:

Consume subset of data from web-monitoring-db as proof of concept, read/write annotations
- DEMO
- LIST VIEW shows first page of records from web-monitor-db JSON endpoint
- PAGE VIEW shows basic info about the latest version of that page: site, urls, and links to Versionista diffs
  - updates annotations

Installation

Ensure you have yarn (installation instructions)
Clone this repo
Install node dependencies with yarn
```
yarn install
```
Copy .env.example to .env and supply any local configuration info you need (all fields are optional)
Build the application
```
gulp
```
Start the web server
```
yarn run start
```
If you are actively developing then use gulp to rebuild application on file changes
```
gulp watch
```

Running tests

To run all tests once

yarn test

while to start the test runner in watch mode

yarn dev

Manual view

Access the main view at http://localhost:3000

Screenshot:

Getting Involved

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.

Troubleshooting

`The program 'gulp' is currently not installed`

If your run into The program 'gulp' is currently not installed error then you can either:

Use local development install of gulp
```
yarn run gulp
# or
npm run gulp    
```
Install gulp globally
```
yarn install --global gulp-cli
```

Contributors

This project wouldn’t exist without a lot of amazing people’s help. Thanks to the following for all their contributions!

Contributions	Name
💻 🎨 📖 💬 👀	Kevin Nguyen
💻 📖 💬 👀	Rob Brackett
📖 📋 💬 👀	Dan Allan
📖 📋 📢	Matt Price
📖 📋	Dawn Walker
📖	Patrick Connolly
📋 🔍	Toly Rinberg
📋 🔍	Andrew Bergman
💡	@ArcTanSusan
💡	@AutumnColeman
💡	@StephenAlanBuckley
💡	@lh00000000
💡	@stuartlynn
💡	@allanpichardo
⚠️	Alberto Zaccagni

(For a key to the contribution emoji or more info on this format, check out “All Contributors.”)

License & Copyright

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.

See the LICENSE file for details.

b5/web-monitoring-ui