aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 2b58f2377d4f6ced520608b61db5974e69fae2bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# IMG

A read only file explorer with media capabilities.
  
# Dev requirements

## qtc

It is used as template engine for html. To install it:

```
go install  github.com/valyala/quicktemplate/qtc@latest
```

## libvips

Libvips[^1] is required by bimp [^2] used for image manipulation.

## ffmpeg

Used to generate video thumbnail.

## sassc

Sassc[^4] is used to generate the css file from sass.

## Bulma

Bulma is the css framework of choice for this project. It is added as sub-module, so don't forget to pull it.

# TODO 

* ~~Thumbnail system~~
* ~~Initial setup process~~
* ~~Single binary output~~
* Better worker pool. Allow cron job and ui config
* Alpine package and demo site
* Single image viewer and show exif info (not sure how yet)
* ~~User base root folder~~
* Albums
* Testing. Since I still on initial iteration phases I'm not adding as many
  testing as I'd like to. Once I set on most of the design I'll add more test
  (is this even done :thinking:).

[^1]: https://github.com/libvips/libvips
[^2]: https://github.com/h2non/bimg
[^3]: https://github.com/alicebob/miniredis
[^4]: https://github.com/sass/sassc
[^5]: https://github.com/photoview/photoview
[^6]: https://github.com/photoview/photoview#why-yet-another-self-hosted-photo-gallery