Skip to content

Commit 10f90a2

Browse files
authored
Move development setup documentation from README to dedicated getting started guide (#792)
1 parent 60b7456 commit 10f90a2

File tree

2 files changed

+41
-33
lines changed

2 files changed

+41
-33
lines changed

README.md

Lines changed: 2 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,8 @@
66

77
For any bugs, questions, or anything else with specifically the code found inside the listings (listing examples code), please submit an issue at the [EssentialCSharp Repo](https://github.com/IntelliTect/EssentialCSharp).
88

9-
## What You Will Need
9+
## Getting Started
1010

11-
- [Visual Studio](https://visualstudio.microsoft.com/) (or your preferred IDE)
12-
- [.NET 9.0 SDK](https://dotnet.microsoft.com/download)
13-
- If you already have .NET installed you can check the version by typing `dotnet --info` into cmd to make sure you have the right version
14-
15-
## Startup Steps
16-
17-
To get the site that is seen at [essentialcsharp.com](https://essentialcsharp.com/):
18-
19-
1. Clone Repository locally.
20-
2. Set any needed secrets
21-
3. If you have do not have access to the private nuget feed, change the line `<AccessToNugetFeed>true</AccessToNugetFeed>` to `<AccessToNugetFeed>false</AccessToNugetFeed>` in [Directory.Packages.props](https://github.com/IntelliTect/EssentialCSharp.Web/blob/main/Directory.Packages.props).
22-
23-
## Environment Prequisites
24-
25-
Make sure the following secrets are set:
26-
In local development this ideally should be done using the dotnet secret manager. Additional information can be found at the [documentation](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets#set-a-secret)
27-
28-
AuthMessageSender:SendFromName = "Hello World Team"
29-
AuthMessageSender:SendFromEmail = "[email protected]"
30-
AuthMessageSender:SecretKey = alongstringofsecretsauce
31-
AuthMessageSender:APIKey = anapikey
32-
Authentication:Microsoft:ClientSecret = anotherimportantsecret
33-
Authentication:Microsoft:ClientId = anotherimportantclient
34-
Authentication:github:clientSecret = anotherimportantclientsecret
35-
Authentication:github:clientId = anotherimportantclientid
36-
HCaptcha:SiteKey = captchaSiteKey
37-
HCaptcha:SecretKey = captchaSecretKey
38-
APPLICATIONINSIGHTS_CONNECTION_STRING = "InstrumentationKey=your-instrumentation-key-here;IngestionEndpoint=https://region.in.applicationinsights.azure.com/;LiveEndpoint=https://region.livediagnostics.monitor.azure.com/"
39-
40-
Testing Secret Values:
41-
Some Value Secrets for Testing/Development Purposes:
42-
HCaptcha: https://docs.hcaptcha.com/#integration-testing-test-keys
11+
For information on setting up your local development environment, please see the [Getting Started Guide](docs/getting-started.md).
4312

4413
Please use issues or discussions to report issues found.

docs/getting-started.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Getting Started with EssentialCSharp.Web Development
2+
3+
This guide will help you set up your local development environment for working on the Essential C# Web project.
4+
5+
## What You Will Need
6+
7+
- [Visual Studio](https://visualstudio.microsoft.com/) (or your preferred IDE)
8+
- [.NET 9.0 SDK](https://dotnet.microsoft.com/download)
9+
- If you already have .NET installed you can check the version by typing `dotnet --info` into cmd to make sure you have the right version
10+
11+
## Startup Steps
12+
13+
To get the site that is seen at [essentialcsharp.com](https://essentialcsharp.com/):
14+
15+
1. Clone Repository locally.
16+
2. Set any needed secrets
17+
3. If you have do not have access to the private nuget feed, change the line `<AccessToNugetFeed>true</AccessToNugetFeed>` to `<AccessToNugetFeed>false</AccessToNugetFeed>` in [Directory.Packages.props](https://github.com/IntelliTect/EssentialCSharp.Web/blob/main/Directory.Packages.props).
18+
19+
## Environment Prerequisites
20+
21+
Make sure the following secrets are set:
22+
In local development this ideally should be done using the dotnet secret manager. Additional information can be found at the [documentation](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets#set-a-secret)
23+
24+
AuthMessageSender:SendFromName = "Hello World Team"
25+
AuthMessageSender:SendFromEmail = "[email protected]"
26+
AuthMessageSender:SecretKey = alongstringofsecretsauce
27+
AuthMessageSender:APIKey = anapikey
28+
Authentication:Microsoft:ClientSecret = anotherimportantsecret
29+
Authentication:Microsoft:ClientId = anotherimportantclient
30+
Authentication:github:clientSecret = anotherimportantclientsecret
31+
Authentication:github:clientId = anotherimportantclientid
32+
HCaptcha:SiteKey = captchaSiteKey
33+
HCaptcha:SecretKey = captchaSecretKey
34+
APPLICATIONINSIGHTS_CONNECTION_STRING = "InstrumentationKey=your-instrumentation-key-here;IngestionEndpoint=https://region.in.applicationinsights.azure.com/;LiveEndpoint=https://region.livediagnostics.monitor.azure.com/"
35+
36+
### Testing Secret Values
37+
38+
Some Value Secrets for Testing/Development Purposes:
39+
HCaptcha: https://docs.hcaptcha.com/#integration-testing-test-keys

0 commit comments

Comments
 (0)