README.md 3.31 KB
Newer Older
1
# Lutim
Luc Didry's avatar
Luc Didry committed
2

3
## What Lutim means?
Luc Didry's avatar
Luc Didry committed
4 5
It means Let's Upload That Image.

6
## What does it do?
7
It stores images and allows you to see them, download them or share them on social networks. From version 0.5, the gif images can be displayed as animated gifs in Twitter, but you need an HTTPS server (Twitter requires that. Lutim detects if you have a HTTPS server and displays a static image twitter card if you don't);
8

9
Images are indefinitely stored unless you request that they will be deleted at first view or after 24 hours / one week / one month / one year.
Luc Didry's avatar
Luc Didry committed
10

11
## License
12
Lutim is licensed under the terms of the AGPL. See the LICENSE file.
Luc Didry's avatar
Luc Didry committed
13

14
## Official instance
15
You can see it working at https://lut.im.
Luc Didry's avatar
Luc Didry committed
16

17
## Logo
18
Lutim's logo is an adaptation of [Lutin](http://commons.wikimedia.org/wiki/File:Lutin_by_godo.jpg) by [Godo](http://godoillustrateur.wordpress.com/), licensed under the terms of the CC-BY-SA 3.0 license.
Luc Didry's avatar
Luc Didry committed
19

20
![Lutim's logo](https://lut.im/img/Lutim_small.png)
Luc Didry's avatar
Luc Didry committed
21

22
## Wiki
Luc Didry's avatar
Luc Didry committed
23

24
The official wiki contains all you need to know about Lutim (installation, API, etc.). Go to <https://framagit.org/luc/lutim/wikis/home> or clone it:
25

Luc Didry's avatar
Luc Didry committed
26
```
27
git clone https://framagit.org/luc/lutim.wiki.git
Luc Didry's avatar
Luc Didry committed
28 29
```

30
## Encryption
31

32
Lutim does encryption on the server if asked to, but does not store the key.
Luc Didry's avatar
Luc Didry committed
33

34
The encryption is done on the server since Lutim is made to be usable even without javascript. If you want to add client-side encryption for javascript-enabled browsers, patches are welcome.
Luc Didry's avatar
Luc Didry committed
35

36
## Internationalization
Luc Didry's avatar
Luc Didry committed
37

38
Lutim comes with English, French and Spanish languages. It will choose the language to display from the browser's settings.
Luc Didry's avatar
Luc Didry committed
39

40
## Authors
41

42
See [AUTHORS.md](AUTHORS.md) file.
43

44
## Contribute!
Luc Didry's avatar
Luc Didry committed
45

46
Please consider contributing, either by [reporting issues](https://framagit.org/luc/lutim/issues) or by helping the [internationalization](https://trad.framasoft.org/project/view/lutim). And of course, code contribution are welcome!
Luc Didry's avatar
Luc Didry committed
47

48
The details on how to contribute are on the [wiki](https://framagit.org/luc/lutim/wikis/contribute).
Luc Didry's avatar
Luc Didry committed
49

50 51 52 53
## Make a donation

You can make a donation to the author on [Tipeee](https://www.tipeee.com/fiat-tux) or on [Liberapay](https://liberapay.com/sky/).

54
## Others projects dependencies
Luc Didry's avatar
Luc Didry committed
55

56
Lutim is written in Perl with the [Mojolicious](http://mojolicio.us) framework.
57

58 59 60 61
It uses:

* [Twitter bootstrap](http://getbootstrap.com) framework to look not too ugly
* [JQuery](http://jquery.com) and [JQuery File Uploader](https://github.com/danielm/uploader/) (slightly modified) to add some modernity
Luc Didry's avatar
Luc Didry committed
62
* [Raphaël](http://raphaeljs.com/) and [morris.js](https://morrisjs.github.io/morris.js/) for stats graphs
63 64 65 66
* [freezeframe.js](http://freezeframe.chrisantonellis.com/) (slightly modified) to be able to freeze animated gifs in twitter card
* [Moment.js](http://momentjs.com/) for displaying real dates instead of unix timestamps.
* [Fontello](http://fontello.com/) and the [markdown font](https://github.com/dcurtis/markdown-mark/) for the icons, licenses for the fontello icons fonts are in `public/font/LICENSE.txt`
* [Henny Penny](https://www.google.com/fonts/specimen/Henny+Penny) font designed by Olga Umpeleva for [Brownfox](http://brownfox.org)
67
* [PhotoSwipe](http://photoswipe.com/) for the gallery
Luc Didry's avatar
Luc Didry committed
68 69
* [JSZip](https://stuk.github.io/jszip/) for generating a zip containing all the images in the gallery
* [FileSaver.js](https://github.com/eligrey/FileSaver.js/) for saving the zip