Skip to content

Commit 349e1a2

Browse files
committed
Add run section in docs
1 parent f96acc5 commit 349e1a2

1 file changed

Lines changed: 46 additions & 1 deletion

File tree

docs/main.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,49 @@ Before you can use the GitHub DevEx Accelerator, you need to set up a GitHub App
123123
You will also need to create 3 repositories in your organization:
124124
- **\<onboarding-repository-name\>**: This repository will be used for onboarding. It should contain the issue templates that will be used for onboarding.
125125
- **\<inventory-repository-name\>**: This repository will be used for inventory. It will contain the inventory metadata.
126-
- **\<policy-repository-name\>**: This repository will be used for the policies. It will contain the policies metadata.
126+
- **\<policy-repository-name\>**: This repository will be used for the policies. It will contain the policies metadata.
127+
128+
# Running the application
129+
130+
You will need a proxy such as [dev tunnels](https://learn.microsoft.com/en-us/azure/developer/dev-tunnels/get-started?tabs=windows) or something such as [Smee](https://smee.io) to route the requests from the GitHub platform to your computer<br/>
131+
132+
To run the application locally, you can use the following command in the terminal:
133+
134+
If you plan on using dev tunnels:
135+
136+
Run the following once:
137+
```bash
138+
dotnet dev-certs https --trust
139+
```
140+
Then run the application with the HTTPS profile:
141+
```bash
142+
dotnet run --launch-profile https
143+
```
144+
145+
If you plan on using a third-party proxy such as Smee, you will need to export the ASP.NET Core development certificate:
146+
147+
Run the following once:
148+
```bash
149+
dotnet dev-certs https --trust --export-path /path/to/aspnetcoredevcert.pfx --password YourPassword --format pfx
150+
```
151+
Then run the application with the HTTPS profile:
152+
```bash
153+
dotnet run --launch-profile https
154+
```
155+
156+
If you are using Smee, you will need to export your certificate to a CER file (a binary X.509 certificate)
157+
```bash
158+
openssl pkcs12 -in /path/to/aspnetcoredevcert.pfx -clcerts -nokeys -out /path/to/aspnetcoredevcert.cer
159+
```
160+
161+
and use export it
162+
```bash
163+
export NODE_EXTRA_CA_CERTS=/path/to/aspnetcoredevcert.cer
164+
```
165+
166+
or in PowerShell:
167+
```powershell
168+
$Env:NODE_EXTRA_CA_CERTS="/path/to/aspnetcoredevcert.cer"
169+
```
170+
171+
The localhost endpoint for Smee to use will be `https://localhost:7135/api/github/webhook`

0 commit comments

Comments
 (0)