Merge branch 'develop'

.github/workflows/docker-image.yml

@@ -0,0 +1,29 @@
+name: Docker Image CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Print Docker version
+        run: docker version
+
+      - name: Build
+        run: docker build -t hie:${{ github.sha }} .
+
+      - name: Run
+        run: |
+          docker run -d --name hie -p 5888:3000 hie:${{ github.sha }}
+          sleep 10
+
+      - name: Test
+        run: |
+          curl --silent --fail http://localhost:5888 || exit 1

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Types of changes:
+
+- **Added** for new features.
+- **Changed** for changes in existing functionality.
+- **Deprecated** for soon-to-be removed features.
+- **Removed** for now removed features.
+- **Fixed** for any bug fixes.
+- **Security** in case of vulnerabilities.
+
+## Unreleased
+
+## [0.1.0-alpha.1] - 2024-09-15
+
+First release.
+
+[0.1.0-alpha.1]: https://github.com/ziteh/hie/releases/tag/v0.1.0-alpha.1

README.md

@@ -4,7 +4,24 @@ Hie - ***Hi***erarchical tag-based image ***E***xplorer.
 
 ## Usage
 
+### Develop
+
 ```sh
 pnpm install
 pnpm run dev
 ```
+
+### Docker
+
+Check [`Dockerfile`](./Dockerfile).
+
+```sh
+# Build
+docker build -t hie .
+
+# Run and expose port 5888 on the host
+docker run -d --name hie -p 5888:3000 -v <HOST_DIR>:/app/data hie
+
+# Save image
+docker save -o hie.tar hie
+```