avatars-api/README.md

1.4 KiB

Avatars API

A self-hosted avatars API using some of the DiceBear CC0 styles

Installation

Development

For run locally it needs a .env file with the environment variables defined in the .env.example

ALLOWED_ORIGINS includes a comma separated list for the allowed CORS sites.

Install dependencies npm install or yarn To start the project run npm run dev or yarn dev

Production

For run it in docker just run docker compose up

Libraries Used

  • DiceBear (for avatar generation)
  • sharp (for png exportation)
  • uuid (for random seeds)

Credits

  • Created by Juan Sebastián Montoya

Credits for Styles:

Title Creator Source Homepage License
Open Peeps Pablo Stanley https://www.openpeeps.com/ https://twitter.com/pablostanley CC0 1.0
Pixel Art DiceBear https://www.figma.com/community/file/1198754108850888330 https://www.dicebear.com CC0 1.0
Thumbs DiceBear https://www.dicebear.com https://www.dicebear.com CC0 1.0

License

This project is licensed under the MIT License.