From 6e17bc11cefdc5d16a60ccfd822b981755b825db Mon Sep 17 00:00:00 2001 From: Soham Banerjee Date: Sat, 23 Oct 2021 14:43:24 +0530 Subject: [PATCH 1/8] instruction to run with newman added Signed-off-by: Soham Banerjee --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4bec5b9..3f7f46b 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,20 @@ 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 +cd /path/to/newman +npm link newman-reporter-dashboard + +bin/newman.js run -r dashboard collection.json +``` + + + ## Environment setup A. Install all dependencies From b21eecf5f68926aed687e08b1ee506c76d43d10e Mon Sep 17 00:00:00 2001 From: Soham Banerjee <63705023+soham4abc@users.noreply.github.com> Date: Sat, 13 Nov 2021 21:20:57 +0530 Subject: [PATCH 2/8] Update README.md Co-authored-by: RISHABH D TIWARI --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 255301b..4eab9c7 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ npm link cd /path/to/newman npm link newman-reporter-dashboard -bin/newman.js run -r dashboard collection.json +newman run -r dashboard collection.json ``` From 36f199245c09e42d4d4bf3435d596cdc5e735702 Mon Sep 17 00:00:00 2001 From: Soham Banerjee <63705023+soham4abc@users.noreply.github.com> Date: Sun, 14 Nov 2021 10:28:04 +0530 Subject: [PATCH 3/8] requested changes added and contributing.md added --- CONTRIBUTING.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 37 +-------------------- 2 files changed, 89 insertions(+), 36 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..74a4ba0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ +# Getting Started with Contributing + +The first thing you need to do is find an issue to work on. Go to Issues and find a suitable issue which you think you can handle and are willing to work on. Make sure you ask the maintainers to have the issue assigned to you before you start working on it. + + +**Step 1:** Fork the repository + +**Step 2:** Clone the forked repository to your local machine with `git clone ` + +**Step 3:** Add a remote (upstream) to your fork using: +``` +git remote add upstream https://github.com/postmanlabs/newman-dashboard.git +``` + +**Step 4:** Synchronize your fork with upstream using the following commands: + +``` + +$ git checkout develop + +$ git fetch upstream + +$ git merge upstream/develop + +$ git push origin develop + +``` + +**Step 5:** Make a branch with a suitable name relevant to the issue you are working on using `git branch ` + +**Step 6:** Switch your working branch from master to the newly created branch with `git checkout ` + +**Step 7:** Work on the changes. You can keep track of your branch and staging area using `git status` + +**Step 8:** Make sure you run the `black` autolinter before you add your changes to the staging area. `black` can be installed on your local system using `pip install black`, and can be run with `black .` on all the files in your current working directory. + +**Step 9:** Add all of the changes you made to the staging area before you commit with `git add .` + +**Step 10:** Commit your changes with a meaningful commit message using `git commit -m "commit message"` + +**Step 11:** Finally push your changes to your forked repository using `git push origin ` + + + + +## 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 pack reporter +``` + +``` +npm i -g newman-reporter-dashboard-0.0.1.tgz +``` + +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 + +``` +cd /path/to/newman +npm link +npm link newman-reporter-dashboard + +newman run -r dashboard collection.json +``` + +## Making your first Pull Request + +Once you have finished working on an issue and have pushed the changes to your forked repository, it is time to make your first pull request. Go to your forked repository on GitHub and it should show you an option to `Compare & pull request`. Click the `Compare & pull request` button and it will directly initiate a Pull Request for you, follow the Pull Request template and fill out the necessary information. Once that is done, click the `Create Pull Request` button. \ No newline at end of file diff --git a/README.md b/README.md index 4eab9c7..72f6c00 100644 --- a/README.md +++ b/README.md @@ -15,42 +15,7 @@ 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 -``` - -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 -cd /path/to/newman -npm link newman-reporter-dashboard - -newman run -r dashboard collection.json -``` + ## [Usage and contribution details (click here)](CONTRIBUTING.md) From 3e362e9b9394e8f97c4ee328894ab96e9f2dc206 Mon Sep 17 00:00:00 2001 From: Soham Banerjee <63705023+soham4abc@users.noreply.github.com> Date: Sun, 14 Nov 2021 10:30:17 +0530 Subject: [PATCH 4/8] typo fixed --- CONTRIBUTING.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 74a4ba0..a87ed82 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,13 +32,11 @@ $ git push origin develop **Step 7:** Work on the changes. You can keep track of your branch and staging area using `git status` -**Step 8:** Make sure you run the `black` autolinter before you add your changes to the staging area. `black` can be installed on your local system using `pip install black`, and can be run with `black .` on all the files in your current working directory. +**Step 8:** Add all of the changes you made to the staging area before you commit with `git add .` -**Step 9:** Add all of the changes you made to the staging area before you commit with `git add .` +**Step 9:** Commit your changes with a meaningful commit message using `git commit -m "commit message"` -**Step 10:** Commit your changes with a meaningful commit message using `git commit -m "commit message"` - -**Step 11:** Finally push your changes to your forked repository using `git push origin ` +**Step 10:** Finally push your changes to your forked repository using `git push origin ` From 2aab1e6e28dc84b49fdda39a424b1e1b3e1337cc Mon Sep 17 00:00:00 2001 From: Soham Banerjee <63705023+soham4abc@users.noreply.github.com> Date: Mon, 15 Nov 2021 19:22:09 +0530 Subject: [PATCH 5/8] Update CONTRIBUTING.md Co-authored-by: Utkarsh Maheshwari --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a87ed82..723a748 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,8 @@ $ git push origin develop ## 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. +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: ``` From 4b6c9b3e7f436aa1d595cf6604627a04985e55d3 Mon Sep 17 00:00:00 2001 From: Soham Banerjee <63705023+soham4abc@users.noreply.github.com> Date: Mon, 15 Nov 2021 19:22:15 +0530 Subject: [PATCH 6/8] Update CONTRIBUTING.md Co-authored-by: Utkarsh Maheshwari --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 723a748..b069a72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,9 @@ This package is mono-repo for the reporter and the dashboard package. The dashbo A. For installation: ``` -npm pack reporter +cd reporter +npm pack +npm i -g newman-reporter-dashboard..tgz ``` ``` From 4adc10499facabb9373e6541313d0bd3a2090886 Mon Sep 17 00:00:00 2001 From: Soham Banerjee <63705023+soham4abc@users.noreply.github.com> Date: Mon, 15 Nov 2021 19:23:09 +0530 Subject: [PATCH 7/8] Update CONTRIBUTING.md Co-authored-by: Utkarsh Maheshwari --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b069a72..65e4112 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,7 +81,8 @@ cd /path/to/newman npm link npm link newman-reporter-dashboard -newman run -r dashboard collection.json +bin/newman.js run -r dashboard collection.json + ``` ## Making your first Pull Request From fb29470c1eded0af32472aa0e72a51c697d2d9bb Mon Sep 17 00:00:00 2001 From: Soham Banerjee <63705023+soham4abc@users.noreply.github.com> Date: Mon, 15 Nov 2021 19:42:09 +0530 Subject: [PATCH 8/8] changes as per request --- CONTRIBUTING.md | 59 ++++++++++++++++--------------------------------- 1 file changed, 19 insertions(+), 40 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65e4112..cca0fca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,46 +1,13 @@ # Getting Started with Contributing -The first thing you need to do is find an issue to work on. Go to Issues and find a suitable issue which you think you can handle and are willing to work on. Make sure you ask the maintainers to have the issue assigned to you before you start working on it. - **Step 1:** Fork the repository -**Step 2:** Clone the forked repository to your local machine with `git clone ` - -**Step 3:** Add a remote (upstream) to your fork using: -``` -git remote add upstream https://github.com/postmanlabs/newman-dashboard.git -``` - -**Step 4:** Synchronize your fork with upstream using the following commands: - +**Step 2:** Clone the forked repository to your local machine with ``` - -$ git checkout develop - -$ git fetch upstream - -$ git merge upstream/develop - -$ git push origin develop - +git clone https://github.com/postmanlabs/newman-dashboard ``` -**Step 5:** Make a branch with a suitable name relevant to the issue you are working on using `git branch ` - -**Step 6:** Switch your working branch from master to the newly created branch with `git checkout ` - -**Step 7:** Work on the changes. You can keep track of your branch and staging area using `git status` - -**Step 8:** Add all of the changes you made to the staging area before you commit with `git add .` - -**Step 9:** Commit your changes with a meaningful commit message using `git commit -m "commit message"` - -**Step 10:** Finally push your changes to your forked repository using `git push origin ` - - - - ## 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. @@ -56,25 +23,34 @@ npm i -g newman-reporter-dashboard..tgz ``` npm i -g newman-reporter-dashboard-0.0.1.tgz ``` +B. Building the frontend: +``` +npm run build +``` -B. Launch the dashboard on `localhost:5001` +C. Launch the dashboard on `localhost:5001` ``` -newman-dashboard +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/` -C. Connect a newman run to the dashboard +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. -D. Run file with Newman +E. Run file with Newman ``` cd /path/to/newman @@ -87,4 +63,7 @@ bin/newman.js run -r dashboard collection.json ## Making your first Pull Request -Once you have finished working on an issue and have pushed the changes to your forked repository, it is time to make your first pull request. Go to your forked repository on GitHub and it should show you an option to `Compare & pull request`. Click the `Compare & pull request` button and it will directly initiate a Pull Request for you, follow the Pull Request template and fill out the necessary information. Once that is done, click the `Create Pull Request` button. \ No newline at end of file +* 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. 🎉 \ No newline at end of file