Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicofilips/bytebrusher
Little NuGet Package to brush up your Collection of photos, videos, documents and so on. Keep your Desktop tidy! 🧹✨
https://github.com/nicofilips/bytebrusher
csharp net8 nuget
Last synced: 2 months ago
JSON representation
Little NuGet Package to brush up your Collection of photos, videos, documents and so on. Keep your Desktop tidy! 🧹✨
- Host: GitHub
- URL: https://github.com/nicofilips/bytebrusher
- Owner: NicoFilips
- License: mit
- Created: 2023-10-06T15:58:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-14T07:06:17.000Z (8 months ago)
- Last Synced: 2024-10-15T03:07:37.375Z (2 months ago)
- Topics: csharp, net8, nuget
- Language: C#
- Homepage: https://www.nuget.org/packages/ByteBrusher
- Size: 1.48 MB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
Source: DALL-E 3
[](https://www.nuget.org/packages/ByteBrusher)
[](https://github.com/NicoFilips/ByteBrusher/actions/workflows/pack-and-deploy-to-nuget-org.yml)
[](https://github.com/NicoFilips/ByteBrusher/actions/workflows/dotnet-build.yml)
[](https://codecov.io/gh/NicoFilips/ByteBrusher)
[](https://opensource.org/licenses/MIT)
[](https://GitHub.com/NicoFilips/ByteBrusher/graphs/contributors/)
Byte Brusher
An awesome little Project to keep your Desktop tidy!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents 📋
-
About The Project
-
Getting Started 🏄
- Usage✨
- Roadmap 🗺️
- Contributing 👨👩👦👦
- License 🏳️
- Contact 🪪
- Acknowledgments 🦉
## About The Project
So, if you're anything like me, you'll realize that it's not always straightforward to manage your data. Whether it's vacation photos, memes, documents, bills, videos, or anything else you need to store, the challenge is real. The task becomes even more daunting when you add the necessity of managing additional backups. And let's face it, your desktop isn't a version control system like git, making it tough to handle all this without considering future changes you might make. This time, I set out to develop an application that corrects past mistakes. It identifies and, if needed, eliminates duplicates.
Here's why:
* Your time should be spent on creating something remarkable, not hunting down duplicates and unnecessary documents.
* Repeating the same tasks over and over isn't efficient.
* Keeping your desktop organized and your storage as minimal as possible is essential. 😄
Admittedly, this project might not be flawless or meet all your needs. So, I plan to make more improvements soon. You're also welcome to suggest changes by forking this repository, creating a pull request, or opening an issue. A big thank you to everyone who takes the time to explore this Repository!
## Architecture🔨
```mermaid
classDiagram
class Your-Program-To-Implement {
DependencyResolver
}
class DependencyResolver{
-CreateHostBuilder(string[] args) IHostBuilder
-ScanUtil
-DeleteUtil
-DuplicateUtil
-FilterUtil
-HashUtil
}
class ScanUtil {
+ScanUtil(IOptions options, ILogger logger)
+GetFiles()
}
class FilterUtil {
+Filter()
}
class DuplicateUtil {
+FindDuplicates()
}
class DeleteUtil {
+DeleteDuplicates()
}
class HashUtil {
+CompareFilehashes()
}
DependencyResolver o-- HashUtil : DI Service
DependencyResolver o-- ScanUtil : DI Service
DependencyResolver o-- FilterUtil : DI Service
DependencyResolver o-- DuplicateUtil : DI Service
DependencyResolver o-- DeleteUtil : DI Service
Your-Program-To-Implement <|-- DependencyResolver : Hosting Extension
```
As you can see, ByteBrusher provides a bunch of Util Classes to implement in your Codebase. If you have a HostBuilder to build and run your App you can headlessly integrate the Codebase into your DI Container to let the Dependency Injection manage your instances.
If you don't use an HostBuilder you're free to directly use the Implementation. Both works like a Charm.
## Built With
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
| Technology | Logo |
|------------|------|
| .NET 6 |  |
| C# |  |
| Serilog |  |
| NUnit |  |
| Moq |  |
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* dotnet
```sh
dotnet build --release
```
### Installation
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
1. Request a Pull Request
2. Clone the repo
```sh
git clone https://github.com/NicoFilips/ByteBrusher.git](https://github.com/NicoFilips/ByteBrusher/
```
3. Restore Nuget packages
```sh
nuget restore
```
4. Start the Application
```csharp
dotnet build --release
```
## Usage
I've coded some extension methods to configure your IHost. It also registers Dependency Injection so you can integrate it into your Apps:
### Register the DI Services into your App:
```
private static void Main(string[] args)
{
IHost host = DependencyResolver.DependencyResolver.CreateHostBuilder(args).Build();
```
### Get Services from your DI Container:
```
CliOptions = host.Services.GetRequiredService();
_byteBrusherClient = host.Services.GetRequiredService();
_logger = host.Services.GetRequiredService>();
```
### Start Brushing your Bytes!
```
_byteBrusherClient.ExecuteAsync(CliOptions.DeleteFlag, CliOptions.Path);
_logger.LogInformation("---- < ByteBrusher.CLI finished > ----");
}
```
## Roadmap
- [x] Build Architecture
- [x] Add Dependency Injection and HostBuilder Extensionmethod
- [x] Add and Handle CLI Arguments
- [x] Filehash Comparison
- [x] Add Serilog
- [x] Unittest for every Util
- [x] Add Codecoverage > 80%
- [ ] Use ML.Net to find redundant Documents
- [ ] Memetemplates
- [ ] Duplicates
- [ ] Find more Contributors!
- [ ] Earn the Startruck Badge!
See the [open issues](https://github.com/NicoFilips/ByteBrusher/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Nico Filips - [email protected]
### Connect with me:
[](https://www.linkedin.com/in/nicofilips/)
[](https://protonmail.com/)
## Acknowledgments
* [CommandLineParser]([https://choosealicense.com](https://github.com/commandlineparser/commandline/wiki))
* [NLog](https://nlog-project.org/)
* [Img Shields](https://shields.io)
* [Font Awesome](https://fontawesome.com)
* [React Icons](https://react-icons.github.io/react-icons/search)
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
[CSHARP]: https://img.shields.io/badge/C%23-239120?style=for-the-badge&logo=c-sharp&logoColor=white
[.NET-badge]: https://img.shields.io/badge/-.NET%206.0-blueviolet
[.NET-url]: https://dotnet.microsoft.com/
[ASP.NET-Core-badge]: # (Hier könnte der Link zum Badge-Bild für ASP.NET Core eingefügt werden)
[ASP.NET-Core-url]: https://dotnet.microsoft.com/apps/aspnet
[Entity-Framework-Core-badge]: # (Hier könnte der Link zum Badge-Bild für Entity Framework Core eingefügt werden)
[Entity-Framework-Core-url]: https://docs.microsoft.com/en-us/ef/core/
[Polly-badge]: # (Hier könnte der Link zum Badge-Bild für Polly eingefügt werden)
[Polly-url]: https://github.com/App-vNext/Polly
[Serilog-badge]: # (Hier könnte der Link zum Badge-Bild für Serilog eingefügt werden)
[Serilog-url]: https://serilog.net/
[xUnit-badge]: # (Hier könnte der Link zum Badge-Bild für xUnit eingefügt werden)
[xUnit-url]: https://xunit.net/
[Moq-badge]: # (Hier könnte der Link zum Badge-Bild für Moq eingefügt werden)
[Moq-url]: https://github.com/Moq/moq4
[AutoMapper-badge]: # (Hier könnte der Link zum Badge-Bild für AutoMapper eingefügt werden)
[AutoMapper-url]: https://automapper.org/
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/NicoFilips/ByteBrusher/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/NicoFilips/ByteBrusher/network/members
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/NicoFilips/ByteBrusher/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/NicoFilips/ByteBrusher/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/NicoFilips/ByteBrusher/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/nicofilips
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com