mirror of
https://github.com/azures04/crafatar.git
synced 2026-03-21 23:41:18 +01:00
47 lines
2.5 KiB
Markdown
47 lines
2.5 KiB
Markdown
# Crafatar [](https://travis-ci.org/crafatar/crafatar/) [](https://coveralls.io/r/crafatar/crafatar) [](https://codeclimate.com/github/crafatar/crafatar)
|
|
[](https://david-dm.org/crafatar/crafatar) [](https://david-dm.org/crafatar/crafatar#info=devDependencies)
|
|
|
|
https://crafatar.com
|
|
|
|
Crafatar serves Minecraft avatars based on the skin for use in external applications.
|
|
Inspired by [Gravatar](https://gravatar.com) (hence the name) and [Minotar](https://minotar.net).
|
|
|
|
Image manipulation is done by [lwip](https://github.com/EyalAr/lwip). 3D renders are created with [node-canvas](https://github.com/Automattic/node-canvas), based on math by [confuser](https://github.com/confuser/serverless-mc-skin-viewer).
|
|
|
|
    
|
|
## Usage / Documentation
|
|
|
|
Please [visit the website](https://crafatar.com) for details.
|
|
|
|
## Contact
|
|
|
|
* You can follow us on [@crafatar](https://twitter.com/crafatar)
|
|
* You can [join us](https://webchat.esper.net/?channels=crafatar) in #crafatar on irc.esper.net.
|
|
|
|
## Installation
|
|
|
|
#### Heroku
|
|
[](https://heroku.com/deploy)
|
|
|
|
#### Dokku
|
|
0. Install the [dokku-redis](https://github.com/ohardy/dokku-redis#redis-plugin-for-dokku) plugin
|
|
0. `dokku redis:start`
|
|
0. You also might want to use [docker-options](https://github.com/dyson/dokku-docker-options) for persistent storage:
|
|
|
|
```docker
|
|
-v /var/lib/crafatar/images:/app/images
|
|
-v /var/log/crafatar:/app/logs
|
|
```
|
|
0. Deploy with ENV config:
|
|
|
|
```bash
|
|
PORT=5000
|
|
BIND=0.0.0.0
|
|
```
|
|
|
|
#### Local
|
|
* [Install](https://github.com/Automattic/node-canvas/wiki) Cairo.
|
|
* `npm install`
|
|
* Start `redis-server`
|
|
* `npm start`
|
|
* Access [http://localhost:3000](http://localhost:3000) |