1
0
mirror of https://github.com/nttgin/BGPalerter.git synced 2024-05-19 06:50:08 +00:00
Files
nttgin-BGPalerter/docs/develop.md

27 lines
1.0 KiB
Markdown
Raw Normal View History

2019-10-05 19:18:11 +02:00
# More information for developers
To start development see how to install the source [here](installation.md#running-bgpalerter-from-the-source-code).
## All npm commands
* `npm run serve` to run the application from the source code
2019-10-05 19:18:11 +02:00
* `npm run test` to run the tests
2020-01-22 17:12:36 +01:00
* `npm run inspect` to run the application with the inspect flag, which allows profiling in Chrome (chrome://inspect).
2019-10-05 19:18:11 +02:00
* `npm run build` to compile and build OS native applications
* `npm run generate-prefixes -- --a ASN(S) --o OUTPUT_FILE` to generate the monitored prefixes file
## Composition notes
You can compose the tool with 3 main components: connectors, monitors, and reports.
> **Important:**
All connectors MUST extend the class Connector. Monitors extend the class Monitor. Reports extend the class Report.
From the superclass they will inherit various generic methods while some have to be implemented.
Reports don't receive only alerts but also the data that provoked such alerts (so you can store the data and replay the accident later).