Obelisk is a WebAPI template built in ASP.Net and used in hundreds of succesful One Beyond projects. Obelisk in its current .NET (Core) form has been in development and production use since early 2018 and draws on developments dating back to 2014 to accelerate delivery of ASP.Net MVC based projects. The core template is supported by core libraries and scaffolder utilities to accelerate development of SPA based front ends, e2e and load tests.
10.0
Obelisk solution uses Directory.Build.props (central package management) for managing common project properties. The framework targets and language versions are specified there and used by all projects within a solution.
Also, Obelisk uses Aspire to run the solution, which consists of:
- Web API to provide API endpoints to external clients
- Workers, based on Azure functions, to handle background processes (like, domain events handling and scheduled tasks)
- Azure storage (based on which Obelisk domain envents handling is implemented)
To run it, please install:
- Docker desktop (Aspire spins up a Docker container for the Azurite storage with a persistent backend)
- Azure Functions Core Tools
- and also make sure that Azure functions and toolsets are up to date. In Visual Studio
Tools->Options->Azure Functions
The default implementation of IEmailSender used in the application will store all generated e-mails in the following folder: C:\inetpub\mailroot\Obelisk (you can find the related code here). This folder can be configured in appsettings.json -> EmailSender -> Folder -> Folder section. Please create this folder manually if it does not exist. Note: this only applies to Windows.
To run the solution in VS, select the AppHost as startup project and press run. Can also dotnet run in the AppHost project.
For more detailed documentation, please refer to our Wiki
If you want to contribute, we are currently accepting PRs and/or proposals/discussions in the issue tracker.