Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions FilterBox/FilterBox.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<OutputType>WinExe</OutputType>
<TargetFramework>net6.0-windows</TargetFramework>
<TargetFramework>net8.0-windows7.0</TargetFramework>
<Nullable>enable</Nullable>
<UseWindowsForms>true</UseWindowsForms>
<ImplicitUsings>enable</ImplicitUsings>
Expand All @@ -22,7 +22,6 @@

<ItemGroup>
<PackageReference Include="Mono.Posix" Version="7.1.0-final.1.21458.1" />
<PackageReference Include="Vanara.PInvoke.Kernel32" Version="3.4.2" />
</ItemGroup>

<ItemGroup>
Expand Down
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<div align="center">
<img src="Images/FilterBox.ico"/>
<h1>FilterBox</h1>
Expand Down Expand Up @@ -40,38 +39,59 @@
</div>

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Description](#description)
- [Screenshots](#screenshots)
- [UI](#ui)
- [Support](#support)

## Features
- __small size:__ app is intentionally built to run on already existing and popular runtimes to reduce footprint
- __event driven:__ does not use any background resources at all
- __performance:__ only filters newly renamed or created files
- __customizable:__ create your own filters inside the app

- **small size:** app is intentionally built to run on already existing and popular runtimes to reduce footprint
- **event driven:** does not use any background resources at all
- **performance:** only filters newly renamed or created files
- **customizable:** create your own filters inside the app

## Installation

### Pre-requisites

- Ensure you have the .NET Desktop Runtime 8.0 installed on your machine. You can download it from [here](https://dotnet.microsoft.com/download/dotnet/8.0).

### Steps

1. Download the latest release of FilterBox from the [releases page](https://github.com/Techial/FilterBox/releases/latest).
2. Extract the downloaded zip file to a directory of your choice.
3. Run `FilterBox.exe` to start the application.

## Description

Have you ever tried coding with Dropbox so you could sync progress and local commits between your computers?
If yes, I'm certain you've Googled __"How to ignore folders Dropbox"__, and found that there's really no easy way out other than having to manually run a Powershell or Shell command every time you create a new app.
If yes, I'm certain you've Googled **"How to ignore folders Dropbox"**, and found that there's really no easy way out other than having to manually run a Powershell or Shell command every time you create a new app.

This software aims to solve this, by always running in the background checking all file changes to see if they match your filters, and then automatically tells Dropbox to ignore uploading these files and/or folders.
Not only does it save your limited Dropbox storage space for other important stuff, it reduces the amount of bandwith used while developing. I've seen 1GB+ ```node_modules``` folders. That's __50% of your free Dropbox storage__.
Not only does it save your limited Dropbox storage space for other important stuff, it reduces the amount of bandwith used while developing. I've seen 1GB+ `node_modules` folders. That's **50% of your free Dropbox storage**.

[Download the app](https://github.com/Techial/FilterBox/releases/latest) or check out the source code above, and reserve your cloud storage for the more important files.

## Screenshots

### Main UI:

![FilterBox UI](/Images/FilterBox.png)

### System tray

![System Tray Menu](/Images/SystemTray.png)

## UI

I'll have to admit that UI really wasn't a priority on this project, but I'll gladly accept any help provided. There's really no limit to how far you can go. If you need help translating the app into a library for your own UI, I'll assist.

Open an [issue](https://github.com/Techial/FilterBox/issues/new) and ping me @Techial :)

## Support

Open an issue if you feel like anything needs to be added. I'll gladly review pull requests and merge them if deemed to be useful!