Skip to content

instruction to run with newman added #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from
Open

instruction to run with newman added #50

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6e17bc1
instruction to run with newman added
soham4abc Oct 23, 2021
73b3438
Merge branch 'develop' into documentation_update
soham4abc Nov 13, 2021
b21eecf
Update README.md
soham4abc Nov 13, 2021
36f1992
requested changes added and contributing.md added
soham4abc Nov 14, 2021
3e362e9
typo fixed
soham4abc Nov 14, 2021
2aab1e6
Update CONTRIBUTING.md
soham4abc Nov 15, 2021
4b6c9b3
Update CONTRIBUTING.md
soham4abc Nov 15, 2021
4adc104
Update CONTRIBUTING.md
soham4abc Nov 15, 2021
fb29470
changes as per request
soham4abc Nov 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,46 @@ Newman Dashboard aims to provide a real-time WebUI dashboard which can let you c

This project was built during [Google Summer of Code 2021](https://summerofcode.withgoogle.com/projects/#5547391014404096) ☀️ with [Postman](https://github.com/postmanlabs) 🚀


## Usage

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
Copy link
Member

@coditva coditva Nov 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should remove this because we've not published the package. See #51

Copy link

@the-rdt the-rdt Nov 13, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually source code for reporter is already there.
All we have to do is execute just one more command before this.

npm pack reporter
This will generate a .tgz file, in my case it was newman-reporter-dashboard-0.0.1.tgz
then we can use
npm i -g newman-reporter-dashboard-0.0.1.tgz to install the package.

@soham4abc are you still working on this? Or should I create an issue for creating a new CONTRIBUTORS.md file and work on this?

Copy link
Author

@soham4abc soham4abc Nov 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am working on this give me some time

```

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.

D. Run file with Newman

```
npm link
Copy link

@the-rdt the-rdt Nov 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think to issue npm link command, you should be in the reporter directory inside newman-dashboard,

cd path/to/newman-dashboard/reporter should be included before npm link command here.

cd /path/to/newman
npm link newman-reporter-dashboard

bin/newman.js run -r dashboard collection.json
```



## Environment setup

A. Install all dependencies
Expand Down