Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrispoulter/halcyon-api
A .NET Core REST API project template 👷 Built with a sense of peace and tranquillity 🙏
https://github.com/chrispoulter/halcyon-api
csharp docker dotnet dotnet-core entity-framework fluent-validation github-actions mailhog mailkit mapster masstransit minimal-api moq postgresql rabbitmq rest-api seq serilog xunit
Last synced: 2 days ago
JSON representation
A .NET Core REST API project template 👷 Built with a sense of peace and tranquillity 🙏
- Host: GitHub
- URL: https://github.com/chrispoulter/halcyon-api
- Owner: chrispoulter
- License: mit
- Created: 2020-08-04T11:11:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T14:08:06.000Z (28 days ago)
- Last Synced: 2024-10-23T16:09:00.266Z (28 days ago)
- Topics: csharp, docker, dotnet, dotnet-core, entity-framework, fluent-validation, github-actions, mailhog, mailkit, mapster, masstransit, minimal-api, moq, postgresql, rabbitmq, rest-api, seq, serilog, xunit
- Language: C#
- Homepage: https://halcyon-api.chrispoulter.com
- Size: 1.57 MB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Halcyon API
A .NET Core REST API project template 👷 Built with a sense of peace and tranquillity 🙏
## Features
- .NET
[https://dotnet.microsoft.com/](https://dotnet.microsoft.com/)
- Entity Framework
[https://learn.microsoft.com/en-us/ef](https://learn.microsoft.com/en-us/ef)
- MassTransit
[https://masstransit.io/](https://masstransit.io/)
- SignalR
[https://learn.microsoft.com/en-us/aspnet/signalr](https://learn.microsoft.com/en-us/aspnet/signalr)
- FluentValidation
[https://fluentvalidation.net/](https://fluentvalidation.net/)
- Mapster
[https://github.com/MapsterMapper/Mapster](https://github.com/MapsterMapper/Mapster)
- Serilog
[https://serilog.net/](https://serilog.net/)
- Swagger
[https://swagger.io/](https://swagger.io/)
- Docker
[https://www.docker.com/](https://www.docker.com/)
- GitHub Actions
[https://github.com/features/actions](https://github.com/features/actions)
## Related Projects
- Halcyon
[https://github.com/chrispoulter/halcyon](https://github.com/chrispoulter/halcyon)
## Getting Started
### Prerequisites
- PostgreSQL
[https://www.postgresql.org/](https://www.postgresql.org/)
- RabbitMQ
[https://www.rabbitmq.com/](https://www.rabbitmq.com/)
- Redis
[https://redis.io/](https://redis.io/)
- MailHog
[https://github.com/mailhog/MailHog](https://github.com/mailhog/MailHog)
- Seq
[https://datalust.co/seq](https://datalust.co/seq)
### Install dependencies
Restore NuGet packages:
```
dotnet restore "halcyon-api.sln"
```
### Update local configuration _(optional)_
In 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.
```
{
"ConnectionStrings": {
"Database": "Host=localhost;Port=5432;Database=halcyon;Username=postgres;Password=password",
"RabbitMq": "amqp://guest:guest@localhost:5672",
"Redis": "localhost"
},
"RateLimiter": {
"PermitLimit": 6,
"ReplenishmentPeriod": 1,
"QueueLimit": 2,
"TokenLimit": 8,
"TokenLimit2": 12,
"TokensPerPeriod": 4,
"AutoReplenishment": true
},
"CorsPolicy": {
"AllowedOrigins": [ "http://localhost:3000" ],
"AllowedMethods": [ "GET", "POST", "PUT", "DELETE", "OPTIONS" ],
"AllowedHeaders": [ "Content-Type", "Authorization", "Access-Control-Allow-Credentials", "X-Requested-With", "x-signalr-user-agent" ]
},
"Email": {
"SmtpServer": "localhost",
"SmtpPort": 1025,
"SmtpUserName": null,
"SmtpPassword": null,
"NoReplyAddress": "[email protected]"
},
"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" ]
}
]
},
"Serilog": {
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft.AspNetCore": "Warning",
"Microsoft.Hosting.Lifetime": "Information"
}
},
"Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ],
"Properties": {
"ApplicationName": "Halcyon.Api"
},
"WriteTo": {
"Console": {
"Name": "Console",
"Args": {
"outputTemplate": "{Timestamp:HH:mm:ss} [{Level:u3}] [{SourceContext}] {Message:lj}{NewLine}{Exception}"
}
},
"Seq": {
"Name": "Seq",
"Args": { "serverUrl": "http://localhost:5341" }
}
}
},
"AllowedHosts": "*"
}
```
### Run the application
```
dotnet run --project "src/Halcyon.Api/Halcyon.Api.csproj"
```
### Access the API
Once running, you can explore the API using Swagger UI at http://localhost:5257
## Testing
This project includes unit tests. To run tests:
```
dotnet test "halcyon-api.sln"
```
## 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](LICENSE) file for details.