diff --git a/README.md b/README.md index 13a5319b..071bc6ad 100644 --- a/README.md +++ b/README.md @@ -6,39 +6,8 @@ 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). -## What You Will Need +## Getting Started -- [Visual Studio](https://visualstudio.microsoft.com/) (or your preferred IDE) -- [.NET 9.0 SDK](https://dotnet.microsoft.com/download) - - 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 - -## Startup Steps - -To get the site that is seen at [essentialcsharp.com](https://essentialcsharp.com/): - -1. Clone Repository locally. -2. Set any needed secrets -3. If you have do not have access to the private nuget feed, change the line `true` to `false` in [Directory.Packages.props](https://github.com/IntelliTect/EssentialCSharp.Web/blob/main/Directory.Packages.props). - -## Environment Prequisites - -Make sure the following secrets are set: -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) - -AuthMessageSender:SendFromName = "Hello World Team" -AuthMessageSender:SendFromEmail = "no-reply@email.com" -AuthMessageSender:SecretKey = alongstringofsecretsauce -AuthMessageSender:APIKey = anapikey -Authentication:Microsoft:ClientSecret = anotherimportantsecret -Authentication:Microsoft:ClientId = anotherimportantclient -Authentication:github:clientSecret = anotherimportantclientsecret -Authentication:github:clientId = anotherimportantclientid -HCaptcha:SiteKey = captchaSiteKey -HCaptcha:SecretKey = captchaSecretKey -APPLICATIONINSIGHTS_CONNECTION_STRING = "InstrumentationKey=your-instrumentation-key-here;IngestionEndpoint=https://region.in.applicationinsights.azure.com/;LiveEndpoint=https://region.livediagnostics.monitor.azure.com/" - -Testing Secret Values: -Some Value Secrets for Testing/Development Purposes: -HCaptcha: https://docs.hcaptcha.com/#integration-testing-test-keys +For information on setting up your local development environment, please see the [Getting Started Guide](docs/getting-started.md). Please use issues or discussions to report issues found. diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 00000000..30dd9e7c --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,39 @@ +# Getting Started with EssentialCSharp.Web Development + +This guide will help you set up your local development environment for working on the Essential C# Web project. + +## What You Will Need + +- [Visual Studio](https://visualstudio.microsoft.com/) (or your preferred IDE) +- [.NET 9.0 SDK](https://dotnet.microsoft.com/download) + - 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 + +## Startup Steps + +To get the site that is seen at [essentialcsharp.com](https://essentialcsharp.com/): + +1. Clone Repository locally. +2. Set any needed secrets +3. If you have do not have access to the private nuget feed, change the line `true` to `false` in [Directory.Packages.props](https://github.com/IntelliTect/EssentialCSharp.Web/blob/main/Directory.Packages.props). + +## Environment Prerequisites + +Make sure the following secrets are set: +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) + +AuthMessageSender:SendFromName = "Hello World Team" +AuthMessageSender:SendFromEmail = "no-reply@email.com" +AuthMessageSender:SecretKey = alongstringofsecretsauce +AuthMessageSender:APIKey = anapikey +Authentication:Microsoft:ClientSecret = anotherimportantsecret +Authentication:Microsoft:ClientId = anotherimportantclient +Authentication:github:clientSecret = anotherimportantclientsecret +Authentication:github:clientId = anotherimportantclientid +HCaptcha:SiteKey = captchaSiteKey +HCaptcha:SecretKey = captchaSecretKey +APPLICATIONINSIGHTS_CONNECTION_STRING = "InstrumentationKey=your-instrumentation-key-here;IngestionEndpoint=https://region.in.applicationinsights.azure.com/;LiveEndpoint=https://region.livediagnostics.monitor.azure.com/" + +### Testing Secret Values + +Some Value Secrets for Testing/Development Purposes: +HCaptcha: https://docs.hcaptcha.com/#integration-testing-test-keys