💂‍♀️ URL Monitor

This demo app lets you monitor selected URLs by periodically sending requests to them and storing responses that can be viewed in the browser using the frontend app.

Demo

TBD

Getting started

If you have Docker installed, you should be able to start the app simply by running

docker-compose up

If that works for you, proceed to the Usage section.

For non-Docker development, please continue reading.

First we need to install Node dependencies using our favourite packages manager in the root of the project, f.e.

yarn
# or
npm install

Development

We have separate development servers for backend (using nodemon and ts-node) and frontend (using Next.js).

To start both servers simultaneously, run

yarn dev
# or
npm run dev

Frontend is served at http://localhost:3000
Backend is served at http://localhost:8080

Code changes are propagated without having to manually restart the servers.

We use concurrently package to run multiple npm scripts at the same time, ensuring cross-platform compatibility.

Usage

Environmental variables

Before running the app, we need to have a valid .env file in the /server folder where we store our secrets. Simply rename the .env.default file to .env and fill in the empty values.

FAUNA_DB_SECRET=
JWT_SECRET=

Authentication

In order to test the app, we first need to get an accessToken via the /login endpoint.

Test users

email	password
[email protected]	batman

Database

We're using a modern serverless database FaunaDB.

API Reference

List of available endpoints:

Login
Get monitor
Create monitor
Edit monitor
Delete monitor
List results
Clear results

Authentication

POST /login

Log in with username/password and receive access token.

Header	Value
Authorization	Basic Base64<username:password>

Response	Value
200	accessToken: string
401	Wrong credentials

---

Monitor CRUD operations

All monitor endpoints require authentication with access token and share the following responses

Header	Value
Authorization	Bearer <accessToken>

Response	Value
400	Wrong request params
401	Wrong credentials
404	Monitor settings not found

Get monitor

GET /monitor?id=${monitorId}

Response	Value
200	MonitoredEndpoint

Create monitor

POST /monitor

Request body:

{
	"name": "test",
	"url": "https://httpbin.org/status/200",
	"monitoredIntervalSeconds": 60
}

Response	Value
200	Monitor ID

Edit monitor

PUT /monitor?id=${monitorId}

Request body:

{
	"name": "test",
	"url": "https://httpbin.org/status/200",
	"monitoredIntervalSeconds": 60
}

Response	Value
204	-

Delete monitor

DELETE /monitor?id=${monitorId}

Response	Value
204	-

---

Monitoring Results

All results endpoints require authentication with access token

Header	Value
Authorization	Bearer <accessToken>

List results

GET /results?monitorId=${monitorId}

Response	Value
200	Array<MonitoringResult>

Clear results

DELETE /results

Clears all results for all users. Technically this should be only accessible by some Admin user but more granular permissions are out of scope of this demo.

Response	Value
204	-

Tests

yarn test
# or
npm test