Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 2.33 KB

README.md

File metadata and controls

33 lines (19 loc) · 2.33 KB

One Beyond

License Maintainability Test Coverage

Introduction

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.

Supported .NET version:

8.0

Setup

The project largely works out of the box when opening with a modern version of Visual Studio.

Please note, Obelisk architecture uses Azure queues to dispatch domain events, to run the solution locally you'll need to have Azurite running.

Also, 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.

Finally, to run Obelisk, simply run the WebApi project through Visual Studio.

Documentation

For more detailed documentation, please refer to our Wiki

Contributing

If you want to contribute, we are currently accepting PRs and/or proposals/discussions in the issue tracker.