https://github.com/antonlydike/imshare

https://github.com/antonlydike/imshare

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/antonlydike/imshare
• Owner: AntonLydike
• Created: 2023-09-15T10:55:00.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-16T12:03:57.000Z (24 days ago)
• Last Synced: 2024-12-16T13:19:41.659Z (24 days ago)
• Language: Python
• Size: 44.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Imshare - an image sharing platform

## How it works:

Folder structure:

 - `state`: The folder structure holding the state of the platform

   - ``: Each "share" has an ID, the shares data is stored here

     - `notes.md`: Notes regarding the share, not visible to the user. Reserved for future use (e.g. in an admin client)

     - `index.md`: Optional message attached to the share

     - `*.jpg`: Images that are to be shared (will be copied over to a web-accesible location, thumbnails will be generated)

     - `state.json`: JSON searilized state information attached to the share such as last updated time, content hash, etc. (not yet in use)

   - `index.md`: Content shown on the landing page

   - `404.md`: 404 Message for unknown shares

 - `static`: Static files that are copied to the web:

    - `*`: copied to a web-accessible location

 - `web`: Target for all staticly generated files

 - `imshare`: Python source files that contain the program

Static files are generated into /web/static/...

Images are processed and stored in a content-adressible manner in /web/mages

## Usage:

To build the static files, run `python -m imshare build`.

Requires imagemagic, exiftool installed and the `markdown` python package to run.

## Features:

- [X] Compress images for serving on the web (8MB file size)

- [X] Generate the right headers for link preview generators

- [X] Have small thumbnails

- [X] Cache images aggressively

- [X] Have visible license notice

- [X] Static hosting friendly

- [X] Responsive design, minimal style

- [X] Image preview in lightbox-style pop-up

- [X] Bulk download as zip (requires NGINX plugin)

- [X] Next/prev controls in lightbox

- [ ] Noscript friendly

- [ ] Add a way to zoom into the images when in lightbox mode

- [ ] Add license information to EXIF data