Skip to content

instant-status/instant-status

Repository files navigation

Instant Status

Total alerts Language grade: JavaScript

Performant, robust, and clean monitoring application

Production Install

The production installation script can be found here.

Recommended Production Infrastructure

instant-status-infrastructure-diagram-thumb click for full resolution zoomable image

For more information and Infrastructure as Code (IaC) for deploying Instant Status, see the deploy repo.

Development

Dependencies

  • Postgres 14 (but 13 should work fine)
  • Node 16
  • HTTPS Server/Domain
  • NGINX

Setup

  1. Prepare Database

    # Ubuntu
    sudo apt install postgresql
    # Log in as posgres user
    sudo su - postgres -c 'psql -U postgres -d postgres'
    
    # Create user, database and grant
    CREATE USER instant_status_user WITH PASSWORD 'randompassword';
    CREATE DATABASE instant_status_db;
    GRANT ALL PRIVILEGES ON DATABASE instant_status_db TO instant_status_user;
  2. Prepare ENVs

    a. Copy ENVs

    cp ui/example.appConfig.ts ui/appConfig.ts && cp is-config/src/example.apiConfig.ts is-config/src/apiConfig.ts && cp is-config/.example.env is-config/.env

    b. Edit ENVs

    vim ui/appConfig.ts is-config/src/apiConfig.ts is-config/.env
  3. Install App Dependencies

    npm run ci
  4. Migrate and seed database

    # In is-prisma
    npm run db:migrate
    npm run db:dev-seed