Files
Pinry/README.md

58 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2019-12-08 21:02:49 +00:00
# ![Pinry](https://raw.github.com/pinry/pinry/master/docs/src/imgs/logo-dark.png)
2024-09-30 22:11:34 +08:00
![NodeJS Build](https://github.com/pinry/pinry/actions/workflows/node.js.yml/badge.svg)
![Python Build](https://github.com/pinry/pinry/actions/workflows/pythonpackage.yml/badge.svg)
2024-10-03 23:21:32 +08:00
![Docker Image Version](https://img.shields.io/docker/v/getpinry/pinry?arch=amd64&style=flat&label=docker-amd64)
2022-02-05 19:08:26 +08:00
![Docker Pulls](https://img.shields.io/docker/pulls/getpinry/pinry)
2022-02-05 19:03:11 +08:00
The open-source core of Pinry, a tiling image board system for people
who want to save, tag, and share images, videos and webpages in an easy
to skim through format.
2024-09-30 22:13:48 +08:00
For more information ( screenshots and document ) visit [https://pinry.github.io/pinry/](https://pinry.github.io/pinry/).
## Features
- Image fetch and online preview
- Tagging system for Pins
- Browser Extensions
- Multi-user support
2019-12-20 00:42:09 +08:00
- Works well with docker
- Both public and private boards (add @2020.02.11)
- Search by tags / Search boards with name (add @2020.02.14)
2022-02-18 21:52:22 -08:00
- Full API support via DRF (add @2022.02.19)
2022-02-21 14:19:04 +08:00
- CLI support (Add image or url to Pinry via [command-line tool](https://github.com/pinry/pinry-cli-py)) (add @2022.02.20)
2022-04-23 01:53:34 +08:00
- i18n support (if you want to help to translate, please contact us in issues) (add @2020.04.23)
2022-09-14 20:35:43 +08:00
- [x] English
- [x] 简体中文
- [x] French Support by [Lilian](https://github.com/LilianBoulard)
2022-05-06 01:10:14 +08:00
## Preview
![image](https://user-images.githubusercontent.com/4109722/166976413-38b575f2-a246-4852-ba05-11bca5f9b052.png)
2019-12-20 00:53:15 +08:00
## Install with Docker
2022-04-22 00:15:29 +08:00
Now we have pre-built docker image on multiple architectures like **ARMv7/ARMv8/AMD64**.
2024-09-30 22:16:18 +08:00
See our full documentation at [https://pinry.github.io/pinry/install-with-docker/](https://pinry.github.io/pinry/install-with-docker/)
## Requirements
2024-09-30 22:16:18 +08:00
See our full documentation at [https://pinry.github.io/pinry/development/](https://pinry.github.io/pinry/development/)
## Development
2024-09-30 22:16:18 +08:00
See our full documentation at [https://pinry.github.io/pinry/development/](https://pinry.github.io/pinry/development/)
## Contributors
The core contributors for Pinry have been/currently are:
* Isaac Bythewood <http://isaacbythewood.com/>
* Krzysztof Klimonda <https://github.com/kklimonda>
* Lapo Luchini <https://github.com/lapo-luchini>
* Ji Qu <https://winkidney.com/>
For a full list of contributors check out the [GitHub Contributors Graph](https://github.com/pinry/pinry/graphs/contributors)