README.md

server-status

Monitoring service for endpoints. A small tool by @adrianmg and @ivanguardado

Server instructions

1/ Ensure that all service backends are up and running. You can do this easily using Docker.

docker-compose up

2/ Install node dependencies.

npm i

3/ Now you can run the API service.

npm run webapi

4/ And the health checker worker.

npm run healthchecker

5/ Open the local url:

http://localhost:3001/{username}/endpoints

Creating data

This step has not been automated yet, so you'll have to create the Mongo documents manually. If you're running docker-compose you can access to the Mongo Express web panel visiting http://localhost:8081/.

1/ Create a new database with the name: endpoint

2/ Create a collection named endpoints.

3/ Now you can add a new endpoint to get monitorized.

{
    _id: "40004fdf-8dbb-478b-8613-9a9ceba22a9f",
    userId: 'username',
    name: 'Personal Website',
    url: 'yourpersonalwebsite.com'
}

Client instructions

1/ Go to the app directory.

cd app

2/ Install node dependencies.

npm i

3/ Run the application server.

npm run dev

4/ Go to the web application.

http://localhost:3000/user/{username}