https://github.com/guibranco/crispywaffle

🧰 🛠️ Crispy Waffle project - toolkit for .NET projects
https://github.com/guibranco/crispywaffle
communication csharp dependency-injection dotnet dotnet-core dotnet-core2 dotnet-framework dotnet-standard hacktoberfest helper-functions helper-tool helpers helpers-library library nuget nuget-package toolkit
Last synced: 22 days ago
JSON representation
🧰 🛠️ Crispy Waffle project - toolkit for .NET projects
Host: GitHub
URL: https://github.com/guibranco/crispywaffle
Owner: guibranco
License: mit
Created: 2019-09-18T20:38:25.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-05-29T00:28:05.000Z (11 months ago)
Last Synced: 2024-05-29T05:31:49.932Z (11 months ago)
Topics: communication, csharp, dependency-injection, dotnet, dotnet-core, dotnet-core2, dotnet-framework, dotnet-standard, hacktoberfest, helper-functions, helper-tool, helpers, helpers-library, library, nuget, nuget-package, toolkit
Language: C#
Homepage: https://guibranco.github.io/CrispyWaffle/
Size: 1.74 MB
Stars: 16
Watchers: 2
Forks: 16
Open Issues: 10
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project

README

        # Crispy Waffle

🧰 🛠️ Crispy Waffle project - a toolkit for .NET projects.

[![GitHub license](https://img.shields.io/github/license/guibranco/CrispyWaffle)](https://github.com/guibranco/CrispyWaffle)

[![Time tracker](https://wakatime.com/badge/github/guibranco/CrispyWaffle.svg)](https://wakatime.com/badge/github/guibranco/CrispyWaffle)

![Crispy Waffle logo](https://raw.githubusercontent.com/guibranco/CrispyWaffle/main/logo.png)

Documentation: [Read the Docs](https://guibranco.github.io/CrispyWaffle/)

---

## Table of content

- [CI/CD](#cicd): Current project status in the build pipeline (AppVeyor).

- [Code Quality](#code-quality): Metrics from some tools about code quality.

- [.NET support](#.NET-support): Supported .NET version. 

- [Installation](#installation): How to install/download this tool.

- [User guide](#user-guide): How to set up, configure and use this tool.

- [Change log](#changelog): Changelog containing the changes done in this project.

- [Support](#support): How to get support.

- [Contributing](#contributing): How to contribute.

---

## CI/CD

| Build status                                                                                                                                                             | Last commit                                                                                                                               | Tests                                                                                                                                                                                     | Coverage                                                                                                                                                                  | Code Smells                                                                                                                                                                     | LoC                                                                                                                                                                         |

| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| [![Build status](https://ci.appveyor.com/api/projects/status/dr93gad0na076ng3/branch/main?svg=true)](https://ci.appveyor.com/project/guibranco/crispywaffle/branch/main) | [![GitHub last commit](https://img.shields.io/github/last-commit/guibranco/CrispyWaffle/main)](https://github.com/guibranco/CrispyWaffle) | [![AppVeyor tests (branch)](https://img.shields.io/appveyor/tests/guibranco/crispywaffle/main?compact_message)](https://ci.appveyor.com/project/guibranco/crispywaffle/branch/main/tests) | [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=coverage)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle) | [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=code_smells)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle) | [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=ncloc)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle) |

---

## Code Quality

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/cdac433295dc4d39b4a5377d147f50fc)](https://www.codacy.com/gh/guibranco/CrispyWaffle/dashboard?utm_source=github.com&utm_medium=referral&utm_content=guibranco/CrispyWaffle&utm_campaign=Badge_Grade)

[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/cdac433295dc4d39b4a5377d147f50fc)](https://www.codacy.com/gh/guibranco/CrispyWaffle/dashboard?utm_source=github.com&utm_medium=referral&utm_content=guibranco/CrispyWaffle&utm_campaign=Badge_Coverage)

[![codecov](https://codecov.io/gh/guibranco/CrispyWaffle/branch/main/graph/badge.svg)](https://codecov.io/gh/guibranco/CrispyWaffle)

[![CodeFactor](https://www.codefactor.io/repository/github/guibranco/CrispyWaffle/badge)](https://www.codefactor.io/repository/github/guibranco/CrispyWaffle)

[![Maintainability](https://api.codeclimate.com/v1/badges/fdaf045297f48946696a/maintainability)](https://codeclimate.com/github/guibranco/CrispyWaffle/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/fdaf045297f48946696a/test_coverage)](https://codeclimate.com/github/guibranco/CrispyWaffle/test_coverage)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=alert_status)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=sqale_index)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=security_rating)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle)

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=bugs)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=guibranco_CrispyWaffle&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=guibranco_CrispyWaffle)

[![DeepSource](https://app.deepsource.com/gh/guibranco/CrispyWaffle.svg/?label=active+issues&show_trend=true&token=r3XGa8MQHGZERdIhKB5EZXfL)](https://app.deepsource.com/gh/guibranco/CrispyWaffle/?ref=repository-badge)

---

## .NET support

As of August 2024, this toolkit is currently published in the following `.NET` versions:

- .NET Standard 2.0

- .NET Standard 2.1

- .NET 6.0

- .NET 8.0

This is an official Microsoft [.NET-supported versions](https://dotnet.microsoft.com/en-us/platform/dotnet-standard) table based on the lowest target version (.NET Standard 2.0):

![Supported version as of Aug/2024](https://raw.githubusercontent.com/guibranco/CrispyWaffle/main/docs/images/supported-versions-2024-08.png)

---

## Installation

### Github Releases

[![GitHub last release](https://img.shields.io/github/release-date/guibranco/CrispyWaffle.svg?style=flat)](https://github.com/guibranco/CrispyWaffle) [![Github All Releases](https://img.shields.io/github/downloads/guibranco/CrispyWaffle/total.svg?style=flat)](https://github.com/guibranco/CrispyWaffle)

Download the latest zip file from the [Release](https://github.com/GuiBranco/CrispyWaffle/releases) page.

### Nuget package manager

| Package                        |                                                                                       Version                                                                                        |                                                                                       Downloads                                                                                        |

| ------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

| **CrispyWaffle**               |                      [![CrispyWaffle NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle/)                       |                      [![CrispyWaffle NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle/)                      |

| **CrispyWaffle.Configuration** | [![CrispyWaffle Configuration NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.Configuration.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Configuration/)  | [![CrispyWaffle Configuration NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.Configuration.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Configuration/) |

| **CrispyWaffle.ElasticSearch** | [![CrispyWaffle ElasticSearch NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.ElasticSearch.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.ElasticSearch/)  | [![CrispyWaffle ElasticSearch NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.ElasticSearch.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.ElasticSearch/) |

| **CrispyWaffle.Elmah**         |             [![CrispyWaffle ELMAH NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.Elmah.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Elmah/)              |             [![CrispyWaffle ELMAH NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.Elmah.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Elmah/)             |

| **CrispyWaffle.EventLog**         |             [![CrispyWaffle Event Log NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.EventLog.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.EventLog/) |             [![CrispyWaffle Event Log NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.EventLog.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.EventLog/)             |

| **CrispyWaffle.Log4Net**       |          [![CrispyWaffle Log4Net NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.Log4Net.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Log4Net/)           |          [![CrispyWaffle Log4Net NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.Log4Net.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Log4Net/)          |

| **CrispyWaffle.RabbitMQ**      |        [![CrispyWaffle.RabbitMQ NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.RabbitMQ.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.RabbitMQ/)          |        [![CrispyWaffle.RabbitMQ NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.RabbitMQ.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.RabbitMQ/)         |

| **CrispyWaffle.Redis**         |             [![CrispyWaffle Redis NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.Redis.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Redis/)              |             [![CrispyWaffle Redis NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.Redis.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Redis/)             |

| **CrispyWaffle.Utils**         |             [![CrispyWaffle Utils NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.Utils.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Utils/)              |             [![CrispyWaffle Utils NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.Utils.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.Utils/)             |

#### Language packages

| Package   |                                                                        Version                                                                         |                                                                         Downloads                                                                         |

| --------- | :----------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: |

| **CrispyWaffle.I18n.PtBr** | [![PT-BR NuGet Version](https://img.shields.io/nuget/v/CrispyWaffle.I18n.PtBr.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.I18n.PtBr/) | [![PT-BR NuGet Downloads](https://img.shields.io/nuget/dt/CrispyWaffle.I18n.PtBr.svg?style=flat)](https://www.nuget.org/packages/CrispyWaffle.I18n.PtBr/) |

More information is available [here](https://guibranco.github.io/CrispyWaffle/installation/).

---

## User guide

The user guide is available [here](https://guibranco.github.io/CrispyWaffle/user-guide/basic-usage/).

---

## Changelog

The changelog is available [here](https://guibranco.github.io/CrispyWaffle/changelog/).

---

## Support

Please [open an issue](https://github.com/guibranco/crispywaffle/issues/new) for support.

---

## Contributing

Refer to [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute to this project!

### Contributors

	

		

            

                

                    

                    


                    _{Guilherme Branco Stracini}

                

            

            

                

                    

                    


                    _{Mohammad Haris}

                

            

            

                

                    

                    


                    _{Batyrkhan Akzholov}

                

            

            

                

                    

                    


                    _{João Vítor Valadares}

                

            

            

                

                    

                    


                    _{Simran Gill}

                

            

            

                

                    

                    


                    _{Thiago Christopher}

                

            

		

		

            

                

                    

                    


                    _{Tiago Schäffer}

                

            

            

                

                    

                    


                    _{Viktorius Suwandi}

                

            

            

                

                    

                    


                    _Yousef

                

            

            

                

                    

                    


                    _akhtareimon

                

            

            

                

                    

                    


                    _mf0zz13

                

            

		

	

### Bots

	

		

            

                

                    

                    


                    _{dependabot[bot]}

                

            

            

                

                    

                    


                    _{github-actions[bot]}

                

            

            

                

                    

                    


                    _{deepsource-autofix[bot]}

                

            

            

                

                    

                    


                    _{penify-dev[bot]}

                

            

            

                

                    

                    


                    _{gitauto-ai[bot]}

                

            

            

                

                    

                    


                    _{stack-file[bot]}

                

            

		

		

            

                

                    

                    


                    _{codefactor-io[bot]}

                

            

            

                

                    

                    


                    _{Snyk bot}
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/guibranco/crispywaffle

Awesome Lists containing this project

README
