Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
69 changes: 69 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Getting Started with Contributing


**Step 1:** Fork the repository

**Step 2:** Clone the forked repository to your local machine with
```
git clone https://github.com/postmanlabs/newman-dashboard
Copy link
Contributor

Choose a reason for hiding this comment

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

@soham4abc can you just check if https cloning of git repositories is across git versions or specific to some?

Copy link
Author

Choose a reason for hiding this comment

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

https cloning causes problems in Git versions older than 1.7.10.
Should I add some more documentation to update git to latest version?

```

## Usage

This package is mono-repo for the reporter and the dashboard package. The dashboard package takes care of launching the dashboard, while the reporter connects to Newman.


A. For installation:
Copy link
Member

Choose a reason for hiding this comment

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

Let's divide the setup into multiple parts: reporter, frontend and dashboard.

Copy link
Member

Choose a reason for hiding this comment

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

We also need to add information about installing node modules, etc.

Copy link
Author

Choose a reason for hiding this comment

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

Yeah we need to just provide me the details and sub-parts I need to create

```
cd reporter
npm pack
npm i -g newman-reporter-dashboard.<version>.tgz
```

```
npm i -g newman-reporter-dashboard-0.0.1.tgz
```
B. Building the frontend:
```
npm run build
```

C. Launch the dashboard on `localhost:5001`

```
cd dashboard
node bin/index.js
```
or, Launch the dashboard in dev mode:
```
npm run dev:dashboard
```

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

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

D. 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.

E. Run file with Newman

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

Choose a reason for hiding this comment

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

I'm no expert on npm link but I think some modifications are required here.

Give a sec to review this please @coditva .

Copy link
Member

Choose a reason for hiding this comment

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

You're right. The npm link needs to be executed in the newman-dashboard/reporter directory.


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

```

Copy link
Member

Choose a reason for hiding this comment

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

We also need to add a section on running and writing tests

Copy link
Author

Choose a reason for hiding this comment

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

please provide me what needs to be written here

## Making your first Pull Request

* Ensure that tests are passing.
* Ensure that lint checks are passing.
* Ask any of the maintainers for review.
* Once any reviewer which write access approves the PR, merge it. 🎉
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ 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 and contribution details (click here)](CONTRIBUTING.md)



## Environment setup

A. Install all dependencies
Expand Down