Skip to content

Latest commit

 

History

History
113 lines (66 loc) · 4.57 KB

README.md

File metadata and controls

113 lines (66 loc) · 4.57 KB
Raw

Welcome to the .NET Hacktoberfest project

We welcome PRs small and large to any .NET open source project on GitHub.

This project is intended to be used as a PR Tracker to help with Hacktoberfest.

Be sure to check the Wiki for more information too!

Hacktoberfest Project Dev Setup

This project currently uses Table Storage for persisting data. To allow for development of this application we are using Cosmos DB Emulator with Table Storage API.

New to .NET and C#?

.NET Core is open source and cross platform.

Come hang out in the Discord and we'll help you!

Emulator download and install instructions
Emulator Configuration

For this project we are using the Table Storage Endpoint which is not enabled by default. To enable this, run the Cosmos Emulator with the command line switch /EnableTableEndpoint e.g.: {{InstallLocation}}\Microsoft.Azure.Cosmos.Emulator.exe /EnableTableEndpoint

Once the emulator is up and running the only thing left to do is to set the connection string and table name in the application. You can use appsettings.json or user secrets.

The connection string should be as follows (the account key shown here is the default one installed by the emulator): DefaultEndpointsProtocol=http;AccountName=localhost;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==;TableEndpoint=http://localhost:8902/;

The table name doesn't matter as it can be unique to your installation. We suggest you use: HacktoberfestProject.

This will make life easier if we need to help you debug an issue.

Github application registration

This will provide you with the client id and secret needed for the secrets configuration below.

Secrets Configuration

This application uses the dotnet user-secrets tool documented here

The following secrets will need setup from within the HacktoberfestProject.Web directory where the .csproj file exists. Run the following commands:

dotnet user-secrets set "CosmosTableStorage:ConnectionString" "DefaultEndpointsProtocol=http;AccountName=localhost;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==;TableEndpoint=http://localhost:8902/;"

dotnet user-secrets set "CosmosTableStorage:TableName" "HacktoberfestProject"

dotnet user-secrets set "GitHub:ClientId" "<replace with your clientid>"

dotnet user-secrets set "GitHub:ClientSecret" "<replace with your client secret>"

Known Issues

The following error occurs due to using http for local development instead of SSL with the Chrome Browser:

An unhandled exception occurred while processing the request. Exception: Correlation failed.

To correct the problem:

  • Visit chrome://flags
  • Change setting Cookies without SameSite must be secure to Disabled.

Styling the front end

The project uses tailwind CSS!

System requirements:

Node.js
npm

To install dependencies, run the following commands:

cd /HacktoberfestProject.Web
npm install

Adding styles

The raw css is stored in /HacktoberfestProject.Web/wwwroot/css/raw.css.

The aim of using tailwind, is this:

Instead of opinionated predesigned components, Tailwind provides low-level utility classes that let you build completely custom designs without ever leaving your HTML.

Ideally, we shouldn't have to add any custom css to raw.css. To follow this pattern, attempt to add and edit styles only in the HTML layout files.

Compiling css

To compile any extra css you add to raw.css, run the following command:

cd /HacktoberfestProject.Web
npm run tailwind

Take a look at package.json to see what the tailwind task is doing. Essentially it takes the wwwroot/css/raw.css file, processes it and moves the output to wwwroot/css/output.css.