https://github.com/glennfaison/uptime-checker

Uptime checker for online resources
https://github.com/glennfaison/uptime-checker

monitor node node-js nodejs twilio-api uptime-checker uptime-monitor

Last synced: 3 months ago
JSON representation

Uptime checker for online resources

• Host: GitHub
• URL: https://github.com/glennfaison/uptime-checker
• Owner: glennfaison
• License: mit
• Created: 2019-12-31T19:09:47.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-12T15:03:47.000Z (almost 4 years ago)
• Last Synced: 2024-06-21T12:26:05.324Z (5 months ago)
• Topics: monitor, node, node-js, nodejs, twilio-api, uptime-checker, uptime-monitor
• Language: JavaScript
• Homepage:
• Size: 877 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - glennfaison/uptime-checker - Uptime checker for online resources (nodejs)

README

        
# Uptime Checker

[![Run on Repl.it](https://repl.it/badge/github/glennfaison/uptime-checker)](https://repl.it/github/glennfaison/uptime-checker)

![Home Page](./public/screenshots/landing_page.jpg)

This application lets users create accounts, register web resources whose availability they would like to monitor, and specify details about the requests they want to make to these resources.

The application will periodically make an HTTP request to these resources, and notify the owners of the checks whenever there is a change in state with the specified resources, i.e., if the state changes from "up/accessible" to "down/inaccessible"

## Motivation

This project was made for demonstration purposes. I built every part of the application from scratch, using only the default Node.js modules. No package.json. No NPM.

## The application

The application consists of 3 main parts:

- a REST API

- a user-facing web application

- and a command-line interface for the application administrator to monitor the application.

## What did I have to do?

To bring this project to fruition, I had to build (and name 🤣) the following:

- An HTTP/HTTPS server with integrated routing functions and the ability to add plugins. It is a minimal express.js clone, [srvr](./lib/srvr)

- An Axios clone to help make HTTP requests within the application, [paxios](./lib/paxios)

- A JSON, file-based data storage utility.

- A Twilio SMS API client to notify the application’s users, [twilight](./lib/twilight)

- A REPL library for the CLI(used as admin panel) of the application

- A templating engine for rendering the application’s HTML, [templatr](./lib/templatr)

- A rudimentary unit testing toolkit for testing the application, [litmus](./lib/litmus)

Through this project, I sought to demonstrate my knowledge of the Node.js API, along with my problem-solving skills with low-level Node.js.

## Run the project

- Clone this project, e.g., `git clone https://github.com/glennfaison/uptime-checker`

- Open the project directory in your terminal, e.g., `cd uptime-checker`

- Create a file at `./lib/twilight/twilio.config.json`, and use `./lib/twilight/twilio.config.json.example` as template. Fill in the details of your Twilio service account to enable the SMS notifications.

- Start the project with `node .` or `node index.js`.

- If you want to include the clustering/multithreading feature, run `node index-cluster.js`

## Screens

### Home

![Home Page](./public/screenshots/landing_page.jpg)

### Register

![Registration Page](./public/screenshots/registration_page.png)

### Sign In

![Sign In Page](./public/screenshots/login_page.jpg)

### Dashboard

![Dashboard](./public/screenshots/dashboard.jpg)

### Create a check

![Create a check](./public/screenshots/create_check.png)

### Update/delete a check

![Update/delete a check](./public/screenshots/update_or_delete_check.png)

### Account Settings

![Account Settings](./public/screenshots/account_settings.png)