Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theohbrothers/webize
Move away from proprietary apps to focus on a browser-first workflow.
https://github.com/theohbrothers/webize
browser browser-first chrome edge firefox gallery html html5 local-filesystem open-standard read view web web-apps web-browser
Last synced: 28 days ago
JSON representation
Move away from proprietary apps to focus on a browser-first workflow.
- Host: GitHub
- URL: https://github.com/theohbrothers/webize
- Owner: theohbrothers
- License: mit
- Created: 2021-08-17T05:54:22.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-28T23:39:47.000Z (about 2 years ago)
- Last Synced: 2023-03-07T01:07:06.507Z (almost 2 years ago)
- Topics: browser, browser-first, chrome, edge, firefox, gallery, html, html5, local-filesystem, open-standard, read, view, web, web-apps, web-browser
- Language: Shell
- Homepage:
- Size: 340 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# webize
[](https://github.com/theohbrothers/webize/actions)
[](https://github.com/theohbrothers/webize/releases/)
Move away from proprietary apps to focus on a browser-first workflow.
`webize` aims to provide the most basic tools to move to a browser-first workflow. For a start, `webize` can generate a local image gallery that may be previewed in the browser at `file:///path/to/index.htm` so that local filesystem images may be consumed in the local browser.
## Philosophy
There are many OSes (platforms) with their own apps for previewing and consuming files. Among all of these interfaces, the most consistent interface is the web browser. We consume websites using the web browser, all apps are powered by the web, and almost every proprietary app out there can be replaced with a web app. So, since we are already familiar with the web browser, why aren't we using it more?
The goal of `webize` is to help the user move another step away from proprietary, platform-specific apps. Any workflow change that reduce reliance on non-browser apps is progress toward this goal.
`webize` is primarily for the use on client side for consuming local content (especially thin clients without or with limited virtualization capability). One may use `webize` on the server, but there should be better static site generators out there.
## Install
```sh
sudo wget -q https://raw.githubusercontent.com/theohbrothers/webize/master/webize -O /usr/local/bin/webize && sudo chmod +x /usr/local/bin/webize
```
## Usage
### Gallery
At present, gallery is kept as minimalistic as possible. But it might already be better than many \[bloated\] previewing apps out there.
```sh
# Linux: Generate index.htm in /path/to for all descendent image files, and opens it in firefox
webize gallery /path/to | xargs firefox
# Cleanup index.htm
webize clean /path/to
# Linux: Generate a scoped index.htm in each descendent folder of /path/to, and opens it in firefox
webize gallery -s /path/to | xargs firefox
# Cleanup index.htm
webize clean -s /path/to
# Mac: Generate index.htm in /path/to for all descendent image files, and opens it in firefox
webize gallery /path/to | xargs open
webize clean /path/to
```
Keyboard shortcuts:
| Key| Behavior |
|---|---|
| LEFT | Previous image
| RIGHT | Next image
| UP | Previous image, or previous row in tile mode
| DOWN | Next image, or next row in tile mode
| PAGEUP | Previous page, or previous page row in tile mode
| PAGEDOWN | Next page, or next page row in tile mode
| HOME | First image
| END | Last image
| ENTER | Expand image
| BACKSPACE | Back to tile mode
| SPACE | Next image
| ESC | Escape from full screen, or back to tile mode
| `F` | Full screen
| `X` | Stretch horizontal
| `Y` | Stretch vertical
| `-` | Tile smaller
| `=` | Tile larger
| `L` | Show / Hide label
| `S` | Toggle sort mode
| `P` | Pin / Unpin menu
| `C` | Copy File Path
## Development
Available as [vscode tasks](.vscode/tasks.json).
```sh
# Test script
./test.sh
# To test the gallery, make some pictures available
cp -rf /path/to .pictures
# Debug (Local browser)
./webize gallery . | xargs firefox
# Debug (Remote browser)
./webize gallery .
docker-compose up
curl --head http://yourserver:8080/.pictures/index.htm
```
## Known issues
- High memory usage on loading `index.htm`, because the actual images are used in `![]()
`.