Files
warehouse/README.md

67 lines
3.7 KiB
Markdown
Raw Normal View History

2023-09-18 20:11:42 +02:00
# 🛠️ Warehouse
2023-08-31 14:45:49 -04:00
2023-09-18 20:11:42 +02:00
## Warehouse is a versatile toolbox for managing flatpak user data, viewing flatpak app info, and batch managing installed flatpaks.
2023-09-01 14:16:12 -04:00
2023-09-02 01:05:50 +02:00
## 🚀 Main Features:
2023-09-01 14:16:12 -04:00
2023-09-18 20:11:42 +02:00
1. **Viewing Flatpak Info:** 📋 Warehouse can display all the information provided by the `flatpak list` command in a user-friendly graphical window. Each item includes a button for easy copying.
2023-09-01 14:16:12 -04:00
2023-09-18 20:11:42 +02:00
2. **Managing User Data:** 🗑️ Flatpaks store user data in a specific system location, often left behind when an app is uninstalled. Warehouse can uninstall an app and delete its data, delete data without uninstalling, or simply show if an app has user data.
2023-09-02 01:05:50 +02:00
2023-09-18 20:11:42 +02:00
3. **Batch Actions:** ⚡ Warehouse features a batch mode for swift uninstallations, user data deletions, and app ID copying in bulk.
2023-09-02 01:05:50 +02:00
2023-09-18 20:11:42 +02:00
4. **Leftover Data Management:** 📁 Warehouse scans the user data folder to check for installed apps associated with the data. If none are found, it can delete the data or attempt to install a matching flatpak.
2023-09-02 01:05:50 +02:00
2023-09-24 23:07:51 -04:00
5. **Manage Remotes:** 📦 Installed and enabled Flatpak remotes can be deleted, and new remotes can be added.
2023-09-24 23:07:10 -04:00
![Various screenshots of Warehouse's abilities](screenshots.png)
2023-09-03 19:41:08 +02:00
2023-09-29 15:11:50 -04:00
## ⏬ Installation:
Warehouse is now available on Flathub! Visit your software store and search for Warehouse, or click this badge.
<a href=https://flathub.org/apps/io.github.flattool.Warehouse><img width='240' alt='Download on Flathub' src='https://dl.flathub.org/assets/badges/flathub-badge-en.png'/></a>
2023-09-05 03:52:15 -04:00
## 💬 Get in Contact
2023-10-04 04:51:43 +07:00
- We have a [Discord Server](https://discord.gg/Sq85C42Xkt) and a [Matrix Room](https://matrix.to/#/#warehouse:beeper.com) to discuss and send announcements in!
2023-09-05 03:52:15 -04:00
- You can always open issues, PRs, and use other GitHub features here
2023-10-09 09:34:49 +02:00
## Code of Conduct
- The Warehouse project follows the [GNOME Code of Conduct](https://wiki.gnome.org/Foundation/CodeOfConduct). See `CODE_OF_CONDUCT.md` for more information.
2023-09-02 01:05:50 +02:00
## Important Notes:
2023-09-18 20:11:42 +02:00
- Translators, I thank you very much for your interest and contributions, but as of now Warehouse is not accpeting any translation work until proper translation infrastructure is in place.
2023-09-02 01:05:50 +02:00
- This project is still in its early stages, developed by a newcomer. Your understanding of potential bugs is greatly appreciated.
2023-09-18 20:11:42 +02:00
- Warehouse assumes flatpak user data is located in the default directory: `~/.var/app`.
- Warehouse does not aim to replace flatpak; it simply facilitates appropriate flatpak commands for the desired actions.
2023-09-02 01:05:50 +02:00
2023-09-29 15:11:50 -04:00
## 🛠️ Installation from Repo Steps:
2023-09-29 15:11:50 -04:00
1. Visit the [releases](https://github.com/flattool/warehouse/releases) page and download `io.github.flattool.Warehouse.flatpak`.
2. Install it using your software store or run the following command:
2023-09-02 01:05:50 +02:00
```shell
2023-09-29 15:11:50 -04:00
flatpak install /path/to/io.github.flattool.Warehouse.flatpak
2023-09-02 01:05:50 +02:00
```
You're all set! Launch the application by clicking its icon in your app menu or running:
```shell
2023-09-29 15:11:50 -04:00
flatpak run io.github.flattool.Warehouse
2023-09-02 01:05:50 +02:00
```
2023-10-04 16:51:43 -04:00
# A ToDo list of the current tasks being worked on
- [x] *Add threading to the addition of remotes
- [x] *!Fix no remotes status page not going away when a new remote is added
- [x] *Allow popular remotes window to be closed by pressing Escape
- [x] *Make orphaned data get size in a thread
- [ ] Somehow make installation of apps not freeze the UI
- [x] +Display dependent runtimes in app properties
2023-10-04 16:52:14 -04:00
- [ ] +Filter by runtimes
2023-10-04 16:51:43 -04:00
- [x] +Indicate apps & runtimes that are EOL
2023-10-04 17:25:56 -04:00
- [x] Remember window size
2023-10-04 16:52:49 -04:00
2023-10-04 16:51:43 -04:00
[ * = Needed before new release, + = New feature, ! = Bug fix ]
## Ideas that might get added but no promise of happening
- Installing new apps via ID match
- Pin / unpin runtimes and apps
- Option to uninstall apps when removing a remote
2023-10-09 09:34:49 +02:00
- Make refreshing the main list after install and uninstall happen in a thread