Halcyon Dotnet

A .NET Core project template 👷 Built with a sense of peace and tranquillity 🙏

Features

• .NET https://dotnet.microsoft.com/
• Entity Framework https://learn.microsoft.com/en-us/ef
• FluentValidation https://fluentvalidation.net/
• FluentEmail https://github.com/lukencode/FluentEmail
• Swagger https://swagger.io/
• Aspire https://learn.microsoft.com/en-us/dotnet/aspire
• Docker https://www.docker.com/
• GitHub Actions https://github.com/features/actions

Getting Started

Prerequisites

• PostgreSQL https://www.postgresql.org/
• MailDev https://github.com/maildev/maildev

Install dependencies

Restore NuGet packages:

dotnet restore

Update local configuration (optional)

In the Halcyon.Api directory of the project, create a new appsettings.Development.json file. This file will override settings in appsettings.json during local development. This file is ignored by Git, so the secrets will not be committed to the repository.

{
  "ConnectionStrings": {
    "Database": "Host=localhost;Port=5432;Database=halcyon-dotnet;Username=postgres;Password=password",
    "Mail": "Host=localhost;Port=1025;Username=mail-dev;Password=password"
  },
  "Email": {
    "NoReplyAddress": "[email protected]",
    "SiteUrl": "http://localhost:5173"
  },
  "Jwt": {
    "SecurityKey": "super_secret_key_that_should_be_changed",
    "Issuer": "HalcyonApi",
    "Audience": "HalcyonClient",
    "ExpiresIn": 3600
  },
  "Seed": {
    "Users": [
      {
        "EmailAddress": "[email protected]",
        "Password": "super_secret_password_that_should_be_changed",
        "FirstName": "System",
        "LastName": "Administrator",
        "DateOfBirth": "1970-01-01",
        "Roles": [ "SYSTEM_ADMINISTRATOR" ]
      }
    ]
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

Run the application

dotnet run --project "Halcyon.AppHost/Halcyon.AppHost.csproj"

Access the .NET Aspire dashboard

Once running, you can explore the .NET Aspire dashboard at https://localhost:17255

Contributing

Feel free to submit issues or pull requests to improve the template. Ensure that you follow the coding standards and test your changes before submission.

License

This project is licensed under the MIT License. See the LICENSE file for details.