Filebase is a database for your files and directories. It's just not another file explorer. You can tag, add notes, organize, categorize, filter, search and quickly find your needed files with an easy-to-use application. Filebase does not modify your existing files or directories and is designed for people who have a lot of files to keep track of and want to keep them organized and located quickly! There are other file utilities on the market but none focus on organization.
This project is strictly for fun and learning new technology. It gets updates when I have time. :)
10/16/2022 The newest push has code to replicate the PouchDB database to CouchDB and UI testing with WDIO. I will update these instructions soon.
Filebase was created out of frustration, I was watching my partner go through her Cricut project images one by one and trying to organize them, I noticed there is no real way to keep track of files and directories with Windows Explorer. Other tools on the market focused on archiving and some modified the files. Searching in Windows Explorer is marginal at best. You can add an attribute to files, but it is slow. I wanted to learn Electron and frustration was the catalyst for Filebase!. If anyone remembers Picasa image viewer from Google that application was the general idea for this application. It was just easy to use and fast. I want to keep this application simple to use and fast no feature bloat.
Filebase is in the early design stages and will be changed often. I can't guarantee that updates will be backwards compatible. Feel free to try but please wait for the first release before you create a bunch of libraries!
Under the hood Filebase uses PouchDB to store file and directory structure using a tree type structure, each of these nodes in the tree can have metadata added to it that will be searchable. This is what makes Filebase unique, a library is a snapshot of a file or directory when its created, if the file structure changes you can reindex the directory. If a file or directory is missing you can remove the reference to it or keep it in the index.
Screenshots of the application.
Main view with created libraries, a library can be a directory or file. If it is a directory Filebase scans the entire directory and indexes it.
Library view with files in directory.
Create a new library - choose a directory or file to index.
Drive info shown.
Settings - choose file extensions to index.
Filebase will always remain free and the other goal is to have cross-platform usability.
Currently, there is no installation package because project is under active development.
If you want to try it in dev, clone the repo and then run npm install, then npm start.
You might need to remove pouchdb package from the main package file when npm install is run. After install is run just add it back and run npm start.
The feature list is the following Library creation and edit. Searching of libraries. File and directory filtering, easy drill down. Searchable metadata related to the libraries and files. Export of database to JSON so it cn be backed up. Archiving of entire libraries safely so tht original files are not damaged. Archived libraries will still be searchable so that finding archived files and directories is easy to do. UnArchiving of libraries safely.
See the open issues for a full list of proposed features (and known issues).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Kevin Brisson - LinkedIn - [email protected]
Project Link: https://github.com/kbrisso/file-base