-
Notifications
You must be signed in to change notification settings - Fork 20
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.
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
base: develop
Are you sure you want to change the base?
Changes from all commits
6e17bc1
73b3438
b21eecf
36f1992
3e362e9
2aab1e6
4b6c9b3
4adc104
fb29470
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 | ||
| ``` | ||
|
|
||
| ## 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: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's divide the setup into multiple parts:
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We also need to add information about installing node modules, etc.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm no expert on Give a sec to review this please @coditva .
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're right. The |
||
|
|
||
| bin/newman.js run -r dashboard collection.json | ||
|
|
||
| ``` | ||
|
|
||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We also need to add a section on running and writing tests
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. 🎉 | ||
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?