{"id":20876189,"url":"https://github.com/chrispoulter/halcyon-api","last_synced_at":"2025-05-12T15:32:06.265Z","repository":{"id":44468854,"uuid":"284955831","full_name":"chrispoulter/halcyon-api","owner":"chrispoulter","description":"A .NET Core REST API project template 👷 Built with a sense of peace and tranquillity 🙏","archived":false,"fork":false,"pushed_at":"2025-04-21T14:14:06.000Z","size":1944,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-21T15:28:59.798Z","etag":null,"topics":["csharp","docker","dotnet","dotnet-core","entity-framework","fluent-email","fluent-validation","github-actions","maildev","mapster","masstransit","minimal-api","postgresql","rabbitmq","redis","rest-api","seq","serilog","signalr","swagger"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrispoulter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-04T11:11:16.000Z","updated_at":"2025-04-05T13:36:05.000Z","dependencies_parsed_at":"2023-10-16T10:47:30.047Z","dependency_job_id":"1482853c-abb5-4c7f-a12c-cd34e61a84cd","html_url":"https://github.com/chrispoulter/halcyon-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispoulter%2Fhalcyon-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispoulter%2Fhalcyon-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispoulter%2Fhalcyon-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrispoulter%2Fhalcyon-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrispoulter","download_url":"https://codeload.github.com/chrispoulter/halcyon-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253765962,"owners_count":21960823,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","docker","dotnet","dotnet-core","entity-framework","fluent-email","fluent-validation","github-actions","maildev","mapster","masstransit","minimal-api","postgresql","rabbitmq","redis","rest-api","seq","serilog","signalr","swagger"],"created_at":"2024-11-18T06:50:21.992Z","updated_at":"2025-05-12T15:32:06.247Z","avatar_url":"https://github.com/chrispoulter.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Halcyon API\n\nA .NET Core REST API project template 👷 Built with a sense of peace and tranquillity 🙏\n\n## Features\n\n- .NET\n  [https://dotnet.microsoft.com/](https://dotnet.microsoft.com/)\n- Entity Framework\n  [https://learn.microsoft.com/en-us/ef](https://learn.microsoft.com/en-us/ef)\n- SignalR\n  [https://learn.microsoft.com/en-us/aspnet/signalr](https://learn.microsoft.com/en-us/aspnet/signalr)\n- FluentValidation\n  [https://fluentvalidation.net/](https://fluentvalidation.net/)\n- FluentEmail\n  [https://github.com/lukencode/FluentEmail](https://github.com/lukencode/FluentEmail)\n- Mapster\n  [https://github.com/MapsterMapper/Mapster](https://github.com/MapsterMapper/Mapster)\n- Serilog\n  [https://serilog.net/](https://serilog.net/)\n- Swagger\n  [https://swagger.io/](https://swagger.io/)\n- Docker\n  [https://www.docker.com/](https://www.docker.com/)\n- GitHub Actions\n  [https://github.com/features/actions](https://github.com/features/actions)\n\n## Getting Started\n\n### Prerequisites\n\n- PostgreSQL\n  [https://www.postgresql.org/](https://www.postgresql.org/)\n- RabbitMQ\n  [https://www.rabbitmq.com/](https://www.rabbitmq.com/)\n- Redis\n  [https://redis.io/](https://redis.io/)\n- MailDev\n  [https://github.com/maildev/maildev](https://github.com/maildev/maildev)\n- Seq\n  [https://datalust.co/seq](https://datalust.co/seq)\n\n### Install dependencies\n\nRestore NuGet packages:\n\n```\ndotnet restore \"halcyon-api.sln\"\n```\n\n### Update local configuration _(optional)_\n\nIn the `src/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.\n\n```\n{\n  \"ConnectionStrings\": {\n    \"Database\": \"Host=localhost;Port=5432;Database=halcyon-api;Username=postgres;Password=password\",\n    \"RabbitMq\": \"amqp://guest:guest@localhost:5672\",\n    \"Redis\": \"localhost\"\n  },\n  \"Email\": {\n    \"SmtpServer\": \"localhost\",\n    \"SmtpPort\": 1025,\n    \"SmtpSsl\": false,\n    \"SmtpUserName\": null,\n    \"SmtpPassword\": null,\n    \"NoReplyAddress\": \"noreply@example.com\",\n    \"SiteUrl\": \"http://localhost:3000\"\n  },\n  \"Jwt\": {\n    \"SecurityKey\": \"super_secret_key_that_should_be_changed\",\n    \"Issuer\": \"HalcyonApi\",\n    \"Audience\": \"HalcyonClient\",\n    \"ExpiresIn\": 3600\n  },\n  \"Seed\": {\n    \"Users\": [\n      {\n        \"EmailAddress\": \"system.administrator@example.com\",\n        \"Password\": \"super_secret_password_that_should_be_changed\",\n        \"FirstName\": \"System\",\n        \"LastName\": \"Administrator\",\n        \"DateOfBirth\": \"1970-01-01\",\n        \"Roles\": [ \"SYSTEM_ADMINISTRATOR\" ]\n      }\n    ]\n  },\n  \"Serilog\": {\n    \"MinimumLevel\": {\n      \"Default\": \"Information\",\n      \"Override\": {\n        \"Microsoft.AspNetCore\": \"Warning\",\n        \"Microsoft.Hosting.Lifetime\": \"Information\"\n      }\n    },\n    \"Enrich\": [ \"FromLogContext\", \"WithMachineName\", \"WithThreadId\" ],\n    \"WriteTo\": {\n      \"Console\": {\n        \"Name\": \"Console\",\n        \"Args\": {\n          \"outputTemplate\": \"{Timestamp:HH:mm:ss} [{Level:u3}] [{SourceContext}] {Message:lj}{NewLine}{Exception}\"\n        }\n      },\n      \"Seq\": {\n        \"Name\": \"Seq\",\n        \"Args\": { \"serverUrl\": \"http://localhost:5341\" }\n      }\n    }\n  },\n  \"OTEL_EXPORTER_OTLP_ENDPOINT\": \"http://localhost:5341/ingest/otlp/v1/traces\",\n  \"OTEL_EXPORTER_OTLP_PROTOCOL\": \"http/protobuf\",\n  \"AllowedHosts\": \"*\"\n}\n```\n\n### Run the application\n\n```\ndotnet run --project \"src/Halcyon.Api/Halcyon.Api.csproj\"\n```\n\n### Access the API\n\nOnce running, you can explore the API using Swagger UI at http://localhost:5257\n\n## Contributing\n\nFeel free to submit issues or pull requests to improve the template. Ensure that you follow the coding standards and test your changes before submission.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrispoulter%2Fhalcyon-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrispoulter%2Fhalcyon-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrispoulter%2Fhalcyon-api/lists"}