StashFolderView

:placard: Summary StashApp Basic Folder View Implementation (English).
:link: Repository https://github.com/ialhabbal/StashFolderView

[!info]
Fork of StashFolderView.

Preview


Features

  1. Folder-style browsing with a masonry (waterfall) image layout and favorites support.
  2. Folder-level read, favorite and delete flags.
  3. Integration with Stash to favorite images and videos.
  4. Simple login interface.
  5. Mobile-friendly layout.
  6. Docker deployment support.
  7. Dedicated views for favorite images and favorite folders.

Installation:

In the directory where you want this program to run:

  1. open a command window (CMD) then type:
  2. git clone GitHub - ialhabbal/StashFolderView: StashApp Basic Folder View Implementation (English)
  3. cd StashFolderView
  4. python -m venv venv
  5. cd venv
  6. cd scripts
  7. Activate
  8. cd..
  9. cd..
  10. pip intall -r requirements.txt
  11. pip install python-dotenv

Deployment

1. Deploy Stash

If you don’t already have Stash deployed, see the upstream project: GitHub - stashapp/stash: An organizer for your porn, written in Go. Documentation: https://docs.stashapp.cc

2. Get a Stash API key

Configure your Stash account credentials and generate an API key.

Configure the .env file (in the main folder)

open the .env file in notepad and fill the required information and save it.

BASE_URL=http://localhost:9999/
JUMP_URL=http://localhost:9999/
USERNAME=Type Your Username that you created in Stash
PASSWORD=Type Your Password that you created in Stash
API_KEY=Type Your API_Key that you created in Stash

3. Run stash-folder-view

Double-click on the file: run.bat
then ctrl-click on either of these links:
 http://127.0.0.1:8000
 http://192.168.1.13:8000

TODO (as per the developer)

  1. Improve floating button behaviors (done)
  2. Show favorite button in masonry grid (done)
  3. Display favorite files and folders on home (done)
  4. Improve login flow (done)
  5. Folder icon list view (done)
  6. Auto-scroll and highlight current folder on the left (done)
  7. Separate favorites page (done)
  8. Favorite-folder view page (done)
  9. Left navigation pinning (removed)
  10. Collapse read folders in left nav (done)
  11. Make breadcrumb scrollable horizontally
  12. Change floating button to go up one level when returning to top

Translated and adapted by ialhabbal