https://github.com/ziteh/hie

A web-based hierarchical tags image explorer (WIP)
https://github.com/ziteh/hie

Last synced: 5 months ago
JSON representation

A web-based hierarchical tags image explorer (WIP)

• Host: GitHub
• URL: https://github.com/ziteh/hie
• Owner: ziteh
• License: mit
• Created: 2024-08-22T11:43:03.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-03T12:35:41.000Z (over 1 year ago)
• Last Synced: 2025-01-11T09:45:51.987Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 386 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          

> [!IMPORTANT]

> This project is currently discontinued, because I think [immich](https://immich.app/) can replace it.

>

> Its [Tags](https://immich.app/docs/features/tags) support nested tags to form a hierarchical structure,  

> and its [External Libraries](https://immich.app/docs/features/libraries) can use the original folder structure to manage image and video files.

# Hie

[![GitHub Actions Workflow Status:build](https://img.shields.io/github/actions/workflow/status/ziteh/hie/build.yml?style=flat-square&label=Build)](https://github.com/ziteh/hie/actions/workflows/build.yml)

[![GitHub Actions Workflow Status:docker-image](https://img.shields.io/github/actions/workflow/status/ziteh/hie/docker-image.yml?style=flat-square&label=Docker&logo=docker)](https://github.com/ziteh/hie/actions/workflows/docker-image.yml)

[![Next JS](https://img.shields.io/badge/Next-black?style=flat-square&logo=next.js&logoColor=white)](https://nextjs.org/)

![screenshot](https://i.imgur.com/5KAjjgz.png)

Hie - ***Hi***erarchical tag-based image ***E***xplorer.

Easily organize your images using a flexible, hierarchical tagging system, where tags can have nested sub-tags, and each image can be associated with multiple tags.

All tag data is centrally stored in a database, ensuring that the original folder structure of your files remains untouched.

Hie can run on a NAS via Docker, allowing you to access and view your images conveniently through web browser.

  About the sample images in screenshot

  
These beautiful images are from Unsplash, their authors and sources are:

  


    
Aaron Burden

    
Anthony DELANOIX

    
Christiane Nuetzel

    
Luca

    
Tim Gouw

  


## Usage

### Develop

```sh

pnpm install

pnpm run prisma:migration

pnpm run dev

```

API docs at , powered by [Swagger UI](https://github.com/swagger-api/swagger-ui).

### Docker

Refer to the [`Dockerfile`](./Dockerfile) and [`docker-compose.yml`](./docker-compose.yml) for more details.

```sh

# Build

docker build -t hie .

# Run and expose port 5888 on the host

docker run -d --name hie -p 5888:3000 -v :/app/volume hie

# Save image

docker save -o hie.tar hie

```

`` refer to the host directory where your images are stored. This will be mounted inside the Docker container at `/app/volume` to allow the app to access your images.