NotifyBC
Home
Docs
Help
GitHub
Home
Docs
Help
GitHub
  • Getting Started

    • Welcome
    • Overview
    • Quick Start
    • Installation
    • Web Console
    • What's New
  • Configuration

    • Configuration Overview
    • Database
    • Admin IP List
    • Reverse Proxy IP Lists
    • HTTP Host
    • Internal HTTP Host
    • Email
    • SMS
    • Subscription
    • Notification
    • Node Roles
    • Cron Jobs
    • RSA Keys
    • Worker Process Count
    • Middleware
    • OIDC
    • TLS Certificates
    • Queue
    • Logging
  • API

    • API Overview
    • Subscription
    • Notification
    • Configuration
    • Administrator
    • Bounce
  • Miscellaneous

    • Health Check
    • Disaster Recovery
    • Memory Dump
    • Benchmarks
    • Bulk Import
    • Developer Notes
    • Upgrade Guide
  • Meta

    • Code of Conduct
    • Security Reporting
    • Acknowledgments

Quick Start

For the impatient, to get NotifyBC instance up and running on localhost, you need

  • internet connection
  • Node.js
  • git
  • (Windows only) Docker Desktop running

then run

docker run --rm --pull always -dp 6379:6379 redis # only on Windows
git clone https://github.com/bcgov/NotifyBC.git
cd NotifyBC
npm i && npm run build
npx cross-env NOTIFYBC_WORKER_PROCESS_COUNT=1 npm run start
# wait till console displays "Server is running at http://0.0.0.0:3000/api"
# => Now browse to http://localhost:3000

If you're running into problems, check out full installation guide.

Prev
Overview
Next
Installation