Skip to content

080624.02/Update Contributing Doc #8804

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.

Sign up for GitHub

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

Merged
chidozieononiwu merged 3 commits into from
Aug 8, 2024
Merged

080624.02/Update Contributing Doc #8804

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
372f5a8
Update Contributing Doc
chidozieononiwu Aug 7, 2024
af3e809
Add Contributing Guide for SPA CLient
chidozieononiwu Aug 8, 2024
4a5f5dc
Update src/dotnet/APIView/ClientSPA/CONTRIBUTING.md
chidozieononiwu Aug 8, 2024
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
3 changes: 3 additions & 0 deletions src/dotnet/APIView/APIViewWeb/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,9 @@ If any of the above steps is showing errors, following are the items to check:

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

### SPA Client

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.

Happy coding!!!!

Expand Down
28 changes: 28 additions & 0 deletions src/dotnet/APIView/ClientSPA/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing

This is the SPA Client project for [APIView](../APIViewWeb/CONTRIBUTING.md)

## Pre-requisites

### Development machine setup
- Ensure you have completed [APIView Setup](../APIViewWeb/CONTRIBUTING.md#development-machine-setup)
- Install angular cli
```
npm install -g @angular/cli
```
- Install node modules at `C:\git\azure-sdk-tools\src\dotnet\APIView\ClientSPA`
```
npm install
```

### Runing SPA CLient Locally
To run client SPA locally use the angular serve command with sll option
Comment thread
chidozieononiwu marked this conversation as resolved.
Outdated
```
ng serve --ssl
```

### Testing SPA CLient Locally
To run client SPA tests use angular test command
```
ng test
```
⚡