Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mreshboboyev/factory-pattern
A .NET application implementing the Factory Pattern to generate invoices in various formats (PDF, TXT, CSV). Utilizes QuestPDF for creating professional PDF documents and the Repository Pattern for organized and maintainable data access.
https://github.com/mreshboboyev/factory-pattern
aspnet-core csv design-patterns dotnet-core factory-pattern file-generation invoice-generation pdf-generation questpdf repository-pattern text
Last synced: about 4 hours ago
JSON representation
A .NET application implementing the Factory Pattern to generate invoices in various formats (PDF, TXT, CSV). Utilizes QuestPDF for creating professional PDF documents and the Repository Pattern for organized and maintainable data access.
- Host: GitHub
- URL: https://github.com/mreshboboyev/factory-pattern
- Owner: MrEshboboyev
- Created: 2024-12-19T17:16:07.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-12-19T18:42:33.000Z (about 2 months ago)
- Last Synced: 2025-02-11T12:55:15.937Z (about 4 hours ago)
- Topics: aspnet-core, csv, design-patterns, dotnet-core, factory-pattern, file-generation, invoice-generation, pdf-generation, questpdf, repository-pattern, text
- Language: C#
- Homepage:
- Size: 9.77 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Factory Pattern for Invoice Generation
This project demonstrates a .NET implementation of the Factory Pattern to generate invoices in multiple file formats (PDF, TXT, and CSV). It uses QuestPDF to create professional-grade PDF documents and follows the Repository Pattern to ensure clean and maintainable data access.
## Features
- **Factory Pattern**: Simplifies the creation of invoices in various file formats.
- **Invoice Generation**: Supports generating invoices as PDF, TXT, and CSV files.
- **QuestPDF Integration**: Produces high-quality and customizable PDF invoices.
- **Repository Pattern**: Provides a structured and maintainable data access layer.
- **Extensible Design**: Easily add support for new file formats or invoice types.
## Prerequisites
- [.NET 6 or higher](https://dotnet.microsoft.com/download)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/MrEshboboyev/FactoryPattern.git
```
2. Navigate to the project directory:
```bash
cd FactoryPattern
```
3. Restore dependencies:
```bash
dotnet restore
```
## Usage
### Invoice Generation
The application uses the Factory Pattern to generate invoices in different formats. Below is an example of how to generate invoices in endpoint:
```csharp
var generator = invoiceGeneratorFactory.CreateInvoiceGenerator(format);
var invoiceData = generator.GenerateInvoice(id);
var contentType = generator.GetContentType();
var fileName = $"Invoice_{id}.{format.ToString().ToLower()}";
return Results.File(invoiceData, contentType, fileName);
```
### Adding New Formats
To support a new file format:
1. Create a new class implementing the `IInvoiceGenerator` interface.
2. Add the new file type to the `InvoiceFormat` enum.
3. Update the `InvoiceGeneratorFactory` to include the new type.
Example:
```csharp
public class ExcelInvoiceGenerator : IInvoiceGenerator
{
public byte[] GenerateInvoice(Guid invoiceId)
{
// Logic to generate an Excel invoice
}
}
```
## Supported File Formats
- **PDF**: Generated using [QuestPDF](https://www.questpdf.com/).
- **CSV**: Comma-separated structured invoice data.
- **TXT**: Simple text-based invoice output.
## Contributing
Contributions are welcome! Follow these steps:
1. Fork the repository.
2. Create a feature branch: `git checkout -b feature-name`.
3. Commit your changes: `git commit -m "Add feature"`.
4. Push to the branch: `git push origin feature-name`.
5. Open a pull request.
## License
This project is licensed under the MIT License. See the `LICENSE` file for more details.
## Acknowledgements
- [QuestPDF](https://www.questpdf.com/)
- [Factory Design Pattern](https://refactoring.guru/design-patterns/factory-method)
- [Repository Pattern](https://martinfowler.com/eaaCatalog/repository.html)
---
Happy coding! 🚀