Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nanmu42/orly
:football: Generate your own O'RLY animal book cover to troll your colleagues | 生成你自己的O'RLY动物书封面，让你的同事惊掉下巴
https://github.com/nanmu42/orly
animal-book api golang image k8s orly orly-cover vue
Last synced: 18 days ago
JSON representation
:football: Generate your own O'RLY animal book cover to troll your colleagues | 生成你自己的O'RLY动物书封面，让你的同事惊掉下巴
- Host: GitHub
- URL: https://github.com/nanmu42/orly
- Owner: nanmu42
- License: mit
- Created: 2018-09-25T09:55:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T06:15:07.000Z (about 2 months ago)
- Last Synced: 2024-10-04T09:55:06.950Z (about 1 month ago)
- Topics: animal-book, api, golang, image, k8s, orly, orly-cover, vue
- Language: Go
- Homepage: https://orly.nanmu.me
- Size: 2.27 MB
- Stars: 784
- Watchers: 8
- Forks: 48
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- stars - nanmu42/orly
- go-awesome - orly - create your own O'RLY animal book cover (Open source library / Graphics Processing)
README
**English** | [中文](https://github.com/nanmu42/orly/blob/master/README_ZH.md)
[](https://github.com/nanmu42/orly/actions)
[](https://github.com/nanmu42/orly/actions)
[](https://hub.docker.com/r/nanmu42/orly)
[](https://goreportcard.com/report/github.com/nanmu42/orly)
[](https://godoc.org/github.com/nanmu42/orly)
# O'RLY Cover Generator
O'RLY Cover Generator is a parody book cover generator, implemented in Golang and Vue.js, supporting a wide range of language including CJK.
[Go to the living demo](https://orly.nanmu.me/) to build your own O'RLY cover and troll your friends and colleagues.
Docker images can be found [here](https://hub.docker.com/r/nanmu42/orly).
# Docker Image
```bash
docker pull nanmu42/orly:[tag]
```
Refer to https://hub.docker.com/r/nanmu42/orly/tags for available tags.
Example config:
```toml
CoverImageDir = "cover-images"
Debug = false
MaxImageID = 41
Port = ":3000"
TitleFont = "fonts/SourceHanSerif-Bold.ttc"
NormalFont = "fonts/SourceHanSans-Medium.ttc"
ORLYFont = "fonts/SourceSansPro-Black.ttf"
QueueLen = 20
WorkerNum = 2
Width = 1000
```
Save as `rly.toml`, mount it into `/app/config`, and run docker image with param `/app/rly -config config/rly.toml`.
# Develop O'RLY
O'RLY can be built in following commands:
```bash
make assets
make all
```
O'RLY consists of an API instance and a static frontend:
* API source lies in `cmd/rly`;
* Frontend source lies in `frontend`
Animal images and font files are in `coverimage` and `font`
respectively.
More documentations can be found in their directory.
# Contributes O'RLY
Contributions are always welcome!
Here are a few directions if you are interested:
* Help translating the frontend(we are using Vue i18n)
* Improve O'RLY
* Add New Features
* Raise a bug report
Or simply...
* Sharing the fun :wink:
# Contributors
Many thanks :hugs: to following contributors:
* [TahsinGokalp](https://github.com/TahsinGokalp) (Turkish translation)
* [wooogi123](https://github.com/wooogi123) (Korean translation)
* [cauldnz](https://github.com/cauldnz) (Adding new animal)
* [Jessica Sachs](https://github.com/JessicaSachs) (Project maintainer!)
* [Hervé](https://github.com/hervehobbes) (French translation)
# Projects in Brotherhood
There are several projects which share the idea:
* [O RLY Cover Generator on dev.to](https://dev.to/rly), where this project gets idea, supporting English only(partial reason for me to build O'RLY), there is also a [slack integration](https://dev.to/rlyslack).
* [Japanese O'Reilly Generator](http://oreilly-generator.com/), with really good user experience, covers are generated in your browser
# Paperwork
"O'RLY Cover Generator" is just a parody, and it has no concern with O'Reilly Media.
This work uses Source Han Serif and Source Han Sans from Adobe and Google,
with participation from partner foundries Changzhou SinoType in China,
Iwata Corporation in Japan, and Sandoll Communications in Korea.
This work uses TrueType version of Source Sans Pro from Adobe by Paul D. Hunt.
The animal(well, not all of them are animal) images are from the [USF ClipArt ETC](https://etc.usf.edu/clipart/) project.
# Acknowledgements
The author would like to thank [JetBrains](https://www.jetbrains.com/?from=ORLY-cover-generator) for providing a JetBrains Open Source license for his open source developments.
# License
Use of this work is governed by the MIT License.
You may find a license copy in project root.