Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 2 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<AccessToNugetFeed>true</AccessToNugetFeed>` to `<AccessToNugetFeed>false</AccessToNugetFeed>` 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 = "[email protected]"
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.
39 changes: 39 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -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 `<AccessToNugetFeed>true</AccessToNugetFeed>` to `<AccessToNugetFeed>false</AccessToNugetFeed>` 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 = "[email protected]"
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