Skip to content

Commit

Permalink
Feature(PR): Create Pull request template
Browse files Browse the repository at this point in the history
* Create template for pull requests
* Update setup and running guide in README
  • Loading branch information
Maasdamind committed Mar 26, 2021
1 parent 7f49879 commit 51364e8
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 2 deletions.
28 changes: 28 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
#se include a summary of the change and which issue it fixes. Please also include relevant motivation and context. List any dependencies that are required for this change. -->

# How was this tested?

<!-- Please describe the tests that you ran to verify your changes. Provide instructions, so we can reproduce. Please also list any relevant details for your test configuration. -->
* Step one etc.

# Type of change

Please check all boxes that apply to this change below.

| Type | Applies ✅|
| ------------------------ | :-------: |
| Backend | |
| Frontend | |
| Github/Ci/Admin | |
| Documentation required | |

# Checklist

Please follow the checklist below and check all completed items as you work on the PR.

I have..
- [ ] performed a self-review of my own code
- [ ] commented my code, particularly in hard-to-understand areas
- [ ] written documentation
- [ ] added automated tests
- [ ] merged dependencies to `develop
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ NATS Topology Visualiser is a visualization and monitoring tool for the open-sou
- [.Net 5](https://dotnet.microsoft.com/download/dotnet/5.0)
- [Node.js and npm](https://nodejs.org/en/download/)

Install all further dependencies with `npm i -D`
### Setup

1. setup node packages by running `npm ci`

### Usage

1. Start backend with `dotnet run` from the sub directory `/backend/`
1. Compile and start backend with `npm run backend`

2. Serve front-end with `npm run serve` from the root directory `/`

Expand Down

0 comments on commit 51364e8

Please sign in to comment.