feat: added dockerfile and updated readme

Signed-off-by: Varun Raj <mailme@varunraj.in>
This commit is contained in:
Varun Raj
2024-08-18 22:42:35 +05:30
parent 4642187066
commit ee682b6764
2 changed files with 27 additions and 2 deletions
+15 -2
View File
@@ -9,11 +9,22 @@ A unofficial immich client to provide better tools to organize and manage your i
[![Immich Power Tools](./screenshots/screenshot-1.jpeg)](https://www.loom.com/embed/13aa90d8ab2e4acab0993bdc8703a750?sid=71498690-b745-473f-b239-a7bdbe6efc21)
### Back story
### 💭 Back story
Recently I've migrated my entire Google photos library to Immich, I was able to successfully migrate all my assets along with its albums to immich. But there were few things like people match that was lacking. I loved Immich UI on the whole but for organizing content I felt its quite restricted and I had to do a lot of things in bulk instead of opening each asset and doing it. Hence I built this tool (continuing to itereate) to make my life and any other Immich user's life easier.
### Getting Started
### 🚀 Getting Started
#### 🐬 Using Docker
You can run the project using `Dockerfile` and `docker-compose.yml` file.
```bash
docker compose up -d
```
#### 🚀 Using Local Setup
> [!NOTE]
> Please use `bun` to run the project. If you don't have `bun` installed, checkout [bun.sh](https://bun.sh/) for installation.
@@ -23,6 +34,7 @@ Copy paste the `.env.example` to `.env` and fill in the values.
```bash
NEXT_PUBLIC_IMMICH_URL="" # Immich API URL
IMMICH_API_KEY="" # Immich API Key
DATABASE_URL="" # Postgress Database URL
```
Refer here for obtaining Immich API Key: https://immich.app/docs/features/command-line-interface#obtain-the-api-key
@@ -33,6 +45,7 @@ Run the development server:
bun run dev
```
### Features
**Immich Related**
+12
View File
@@ -0,0 +1,12 @@
version: '3.8'
services:
immich_power_tools:
container_name: immich_power_tools
build:
context: .
dockerfile: Dockerfile
ports:
- "3000:3000"
env_file:
- .env