parzival272000 / newman-dashboard Goto Github PK

Newman Dashboard aims to provide a real-time WebUI dashboard which can let you control and view the currently executing as well as the previously executed newman runs. This would help you debug and analyze your runs from a single endpoint and notify about any error which might occur during the run.

This project was built during Google Summer of Code 2021 ☀️ with Postman 🚀

This package is both a reporter and a standalone package. The standalone package takes care of launching the dashboard, while the reporter connects to the newman run.

A. For installation:

npm install -g newman-dashboard

B. Launch the dashboard on localhost:5001

newman-dashboard

You can also choose to daemonize the dashboard using the --daemonize flag.

The dashboard frontend would now be visible on http://localhost:5001/

C. Connect a newman run to the dashboard

newman run collection.json -r dashboard

This will connect the run to the dashboard and you would be able to view its status on the frontend.

A. Install all dependencies

npm install

B. Run the CLI for launching the dashboard

node ./bin/index <args>

C. Running the tests

// The complete test suite along with linting
npm test

// Only linting
npm run test:lint

// Only the test suite
npm run test:suite