crafatar/README.md

Crafatar

https://crafatar.com

Crafatar serves Minecraft avatars based on the skin for use in external applications. Inspired by Gravatar (hence the name) and Minotar.

Image manipulation is done by lwip. 3D renders are created with node-canvas, based on math by confuser.

Usage / Documentation

Please visit the website for details.

Contact

• You can follow us on @crafatar
• Open an issue on GitHub
• You can join us in #crafatar on irc.esper.net.

Installation

Heroku

Dokku

1. Install the dokku-redis plugin
2. dokku redis:start

3. You also might want to use docker-options for persistent storage:

   -v /var/lib/crafatar/images:/app/images
   -v /var/log/crafatar:/app/logs
   

4. Deploy with ENV config:

   PORT=5000
   BIND=0.0.0.0
   

Local

• Use io.js
• Install Cairo.
• npm install
• Start redis-server
• npm start
• Access http://localhost:3000

Tests

npm test

If you want to debug failing tests, you can set the env

VERBOSE_TEST=true

To debug caching, it can be helpful to monitor redis commands while tests are running:

redis-cli monitor