Code Monkey home page Code Monkey logo

onebeyond-studio-obelisk's Introduction

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.

onebeyond-studio-obelisk's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

onebeyond-studio-obelisk's Issues

FEATURE: Provide page size limits for List queries

When quering collections of data (GetList) in our WebAPI, we do not control the page size of the data to be retrieved, i.e. if someone said per-page=1000000 then we'd return up to 1000000 entities in our response. That would be good if we can introduce (configurable) limits on the data page size for List queries.

Also, if this logic is implememtned, we need to let customers know, what was the real page size used versus the one they asked for. For these purposes we can either adjust the existing PagedList response or return additional information in the response headers:

X-Pagination-Per-Page,
X-Pagination-Total-Count,
X-Pagination-Page-Count,
X-Pagination-Current-Page

cc @fabiomaistro @dcsl-alexis

FEATURE: Automatically fill in Swagger API Version

The API version is selected from the top right dropdown on Swagger, but the required "version" parameter must be entered manually.
image

Setting options.SubstituteApiVersionInUrl = true; in services.AddVersionedApiExplorer of WebApi's Program.cs will allow Swagger to understand how to fill in the parameter.

I have code ready to push, but need to get authorised ... I'm new to contributing on git-hub!

WebUI - Potentially Redundant Code

There is some potentially redundant code - someone should go through and check.

src/OneBeyondStudio.Obelisk.WebUI/src/js/grids/syncfusionGrid/commonDataAccessors.ts

Seems like an initial candidate.

DCSL Mentioned

Lots of the code is still in dcslcomponents and refers to DCSL everywhere.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.