Skip to content

Commit ef6e24b

Browse files
080624.02/Update Contributing Doc (#8804)
* Update Contributing Doc * Add Contributing Guide for SPA CLient * Update src/dotnet/APIView/ClientSPA/CONTRIBUTING.md Co-authored-by: Praven Kuttappan <55455725+praveenkuttappan@users.noreply.github.com> --------- Co-authored-by: Praven Kuttappan <55455725+praveenkuttappan@users.noreply.github.com>
1 parent 13fc5bd commit ef6e24b

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

src/dotnet/APIView/APIViewWeb/CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,9 @@ If any of the above steps is showing errors, following are the items to check:
169169

170170
- Verify and ensure cosmos DB instance has all 3 containers as per the instructions above and verify partition key for each of them.
171171

172+
### SPA Client
173+
174+
APIView uses a SPA (Single Page Application) for part of its user interface. If adding completely new pages please make the contributions to the SPA client. See [SPA Client Contributing Doc](../ClientSPA/CONTRIBUTING.md) for more information.
172175

173176
Happy coding!!!!
174177

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
This is the SPA Client project for [APIView](../APIViewWeb/CONTRIBUTING.md)
4+
5+
## Pre-requisites
6+
7+
### Development machine setup
8+
- Ensure you have completed [APIView Setup](../APIViewWeb/CONTRIBUTING.md#development-machine-setup)
9+
- Install angular cli
10+
```
11+
npm install -g @angular/cli
12+
```
13+
- Install node modules at `C:\git\azure-sdk-tools\src\dotnet\APIView\ClientSPA`
14+
```
15+
npm install
16+
```
17+
18+
### Runing SPA CLient Locally
19+
To run client SPA locally use the angular serve command with ssl option
20+
```
21+
ng serve --ssl
22+
```
23+
24+
### Testing SPA CLient Locally
25+
To run client SPA tests use angular test command
26+
```
27+
ng test
28+
```

0 commit comments

Comments
 (0)