Code Monkey home page Code Monkey logo

easify.reports's Introduction

Easify.Reports

The library facilitates the generation of Excel and Json based results from different providers.

Get Started

How to use

Install-Package Easify.Reports

or

dotnet add package Easify.Reports

Then you can add the following code to your startup to enable reporting support in ServiceCollection

services.AddReporting();

The following interfaces should be implemented and registered with ServiceCollection

Excel

The excel output renderer expects a template to be filled in by different providers. The excel rendered tries to map a named region in the excel to a simple or composite entity. The following interfaces should be provided to enable the end to end process:

  • **ITemplateProvider": This is purely for the Excel output rendering and provides the empty template for Excel containing named regions. Multiple templates can be defined to cover each report type

As each section of the report can be provided from different data source, A series of interfaces need to be implemented for each entity

  • SingleSnapshotDataRenderer or CompositeSnapshotDataRenderer: Abstract classes to define how rendering needs to be done for a specific entity (T). Single is applying only one formatter and composite is required when multiple formatting is the target.
  • ExcelFormatter or GroupExcelFormatter: Formatting the output including headers and rows. Group formatter is when single header is required with multiple grouped rows.

How to Engage, Contribute, and Give Feedback

Description of the steps or process to be a contributor to the project.

Some of the best ways to contribute are to try things out, file issues, join in design conversations, and make pull-requests.

  • Be an active contributor: Check out the contributing page to see the best places to log issues and start discussions.
  • Roadmap: The schedule and milestone themes for project.

Reporting bugs and useful features

Security issues and bugs should be reported by creating the relevant features and bugs in issues sections

Related projects

easify.reports's People

Contributors

moattarwork avatar

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.