/sentry.api

The AXI Sentry system monitors and records Thargoid Incursions in the game Elite: Dangerous.

Primary LanguageJavaScript

MIGRATED

Sentry.api is now part of the Thargid.watch project, the code has been merged and these now run under the same application. https://github.com/antixenoinitiative/thargoid.watch

AXI Sentry

The AXI Sentry system monitors and records Thargoid Incursions in the game Elite: Dangerous.

Sentry takes data from the Elite Dangerous Data Network, the data is processed and filtered for certain system states and stores it in a PostgreSQL database.

The information is then published through multiple API endpoints in the form of JSON.

Data Flow

The following diagram explains the flow of data through AXI Sentry:

image

API Endpoints

You can view the API Endpoints at https://sentry.antixenoinitiative.com/

How to use for development (Listener)

  1. Download the repository and run npm i
  2. Create a PostgreSQL database (Try https://customer.elephantsql.com/instance for a simple test server)
  3. Run the DB Query in DBSETUP to create the tables
  4. Create a file called .env, include your DB Secrets like so,

image

  1. Use npm run start to start AXISentry