|
6 | 6 |
|
7 | 7 | 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). |
8 | 8 |
|
9 | | -## What You Will Need |
| 9 | +## Getting Started |
10 | 10 |
|
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). |
43 | 12 |
|
44 | 13 | Please use issues or discussions to report issues found. |
0 commit comments