IOKode.OpinionatedFramework.ContractImplementations.FileSystem 0.0.8-dev

OpinionatedFramework

<p align="center"> <em>Architectural Clarity, Without the Constraints.</em> </p>

OpinionatedFramework is a robust, comprehensive .NET 7+ framework designed to streamline the development of the application/domain layer. With a strong focus on architectural principles and modern development practices, OpinionatedFramework assists developers in implementing scalable and maintainable software solutions.

The heart of OpinionatedFramework is our opinionated approach. We provide a suite of tools that guide and structure the way you develop your application, making design decisions with experience and best practices in mind. This does not limit flexibility, as our core interfaces have default implementations but allow for custom ones.

Status

Ensure API 1.0.0 is now launched!

While the rest of the framework remains in active development and is not launched, the Ensure API is now launched. See documentation and NuGet page.

Active development – Not launched yet

OpinionatedFramework is currently in active development and has not been officially launched yet.

As we are in the active development stage, some features such as the Unit of Work implementations may not be currently available. These features are on our development roadmap and we're diligently working to implement them in upcoming releases.

Additionally, please note that we have not released any NuGet packages yet. We're aiming to make our first release as comprehensive and robust as possible. We appreciate your patience and understanding.

Why use OpinionatedFramework?

While the usual practice is to keep the application layer independent of the framework, OpinionatedFramework is an exception to the rule. Here's why:

Minimal infrastructure coupling

With OpinionatedFramework, you aren't actually coupled to the infrastructure. Your application layer can remain neutral, giving you the freedom to use your app in a web, mobile, or desktop context without traditional framework dependencies. Need to send emails? You can either use a straightforward SMTP approach or switch to something more custom like MailChimp by simply providing custom implementations of the contracts.

Don't reinvent the wheel

Starting a new project often means creating foundational interfaces like EmailSender or UnitOfWork in the application layer and implementing them in the infrastructure layer. With OpinionatedFramework, you no longer need to do this. We provide these interfaces out of the box, reducing boilerplate and getting you up and running faster.

Not coupled to the infrastructure

Our default implementations are conveniently placed in a separate package. This means your application layer won't be forced to depend on it. Your infrastructure layer can choose to use these default implementations or easily substitute its own, giving you both flexibility and control over your project's infrastructure.

OpinionatedFramework simplifies the entire development process. It streamlines your project setup, facilitates architectural decisions, and significantly reduces the time you spend on repetitive tasks, allowing you to focus on building what really matters: your application's unique features.

Features

OpinionatedFramework comes bundled with a myriad of features:

• Command: Implement use-cases with middleware support and scoped services.
• FileSystem: Infrastructure-agnostic file system. Local, InMemory and Google Cloud Storage implementations will be available.
• Persistence: Incorporate the Unit of Work pattern. NHibernate and MongoDB implementations will be available.
• Emailing: Send emails easily, with a default MailKit implementation.
• Encryption: Safeguard sensitive data with our encrypter.
• Events: Handle domain events effectively.
• Job Queue: Manage background tasks efficiently.
• Job Scheduling: Plan and schedule tasks effortlessly.
• Notifications: Notify users via different channels like email, SMS, Slack, Teams, etc.
• Text translations: Localize your applications easily.
• Validation: Validate preconditions, postconditions and invariants.
• Service Container: Implement a service container without dependency injection, using a static locator with scope in a command execution.
• Facades: Gain easy, static access to contracts.

Core interfaces

Our core interfaces each have a default implementation, but can also be customized according to your specific needs:

How to use

Detailed documentation on how to use each feature will be available in our wiki. Stay tuned!

Who is using OpinionatedFramework

Nobody yet. Wait to the first release.

Sponsors

OpinionatedFramework is currently looking for sponsors to support the ongoing development and maintenance of the project. If you are interested in sponsoring, please visit our Sponsorship Page for more details.

We appreciate the support of all our sponsors. Your contribution will go a long way in helping us build and maintain this framework for the benefit of all .NET developers!

Contributors

We love our contributors! Check out the Contributors page to see who has contributed to the project, and find out how you can contribute too.

License

OpinionatedFramework is licensed under the BSD 2-Clause License. See LICENSE for more information.

Contact

For any questions, issues, or feedback, please feel free to file an issue or open a discussion.