https://github.com/chrispoulter/halcyon-aspire
A .NET Core web project template 👷 Built with a sense of peace and tranquillity 🙏
https://github.com/chrispoulter/halcyon-aspire
aspire csharp dotnet entity-framework fluent-validation github-actions maildev mapster masstransit minimal-api moq postgresql rabbitmq react react-router redis rest-api signalr swagger typescript
Last synced: 4 months ago
JSON representation
A .NET Core web project template 👷 Built with a sense of peace and tranquillity 🙏
- Host: GitHub
- URL: https://github.com/chrispoulter/halcyon-aspire
- Owner: chrispoulter
- License: mit
- Created: 2024-12-02T11:30:02.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-18T16:57:38.000Z (4 months ago)
- Last Synced: 2025-02-18T17:49:50.168Z (4 months ago)
- Topics: aspire, csharp, dotnet, entity-framework, fluent-validation, github-actions, maildev, mapster, masstransit, minimal-api, moq, postgresql, rabbitmq, react, react-router, redis, rest-api, signalr, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 941 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Halcyon Aspire
A .NET Core web 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)
- Swagger
[https://swagger.io/](https://swagger.io/)
- Vite
[https://vite.dev/](https://vite.dev/)
- React
[https://react.dev/](https://react.dev/)
- React Router
[https://reactrouter.com/](https://reactrouter.com/)
- TanStack Query
[https://tanstack.com/query](https://tanstack.com/query)
- Shadcn UI
[https://ui.shadcn.com/](https://ui.shadcn.com/)
- React Hook Form
[https://react-hook-form.com/](https://react-hook-form.com/)
- Zod
[https://zod.dev/](https://zod.dev/)
- Tailwind CSS
[https://tailwindcss.com/](https://tailwindcss.com/)
- Aspire
[https://learn.microsoft.com/en-us/dotnet/aspire](https://learn.microsoft.com/en-us/dotnet/aspire/)
- GitHub Actions
[https://github.com/features/actions](https://github.com/features/actions)
## 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/)
- MailDev
[https://github.com/maildev/maildev](https://github.com/maildev/maildev)
### Install dependencies
Restore NuGet packages:
```
dotnet restore
```
### 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",
"Mail": "Endpoint=smtp://localhost:1025;Username=mail-dev;Password=password"
},
"Email": {
"NoReplyAddress": "[email protected]",
"CdnUrl": "http://localhost:3000"
},
"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 "src/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](LICENSE) file for details.