/url_monitor_api

A Simple REST API to monitor websites, and send notifications to users when website availability changes

Primary LanguageTypeScript

URL Monitoring API

A Simple REST API to monitor websites, and send notifications to users when website availability changes

Used Tools & Technologies

Docker

Dependencies

Application is dockerized, all you need is to have docker-compose

Getting Started

  1. Checkout this repository

    git clone https://github.com/3omar-mostafa/url_monitor_api.git

  2. Create .env file based on example.env template

  3. Run using docker

    cd url_monitor_api
docker-compose up -d

    The above command assumes the environment variables are located in .env, to use another file you can use ENV_FILE

    cd url_monitor_api
ENV_FILE=prod.env docker-compose up -d --env-file "${ENV_FILE}"

Dependencies

  • node.js >= 16

  • MongoDB

    # Install npm dependencies
npm install

Getting Started

  1. Checkout this repository

    git clone https://github.com/3omar-mostafa/url_monitor_api.git

  2. Create .env file based on example.env template

  3. Running the app

    # development
npm run start
    # watch mode
npm run start:dev
    # production mode
npm run start:prod

  4. Test (Optional)

    # unit tests
npm run test
    # e2e tests
npm run test:e2e
    # test coverage
npm run test:cov

API Documentation

Postman docs