Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microvoid/retro-avatar
Create indenticon like Github and Gravatar (retro) avatars.
https://github.com/microvoid/retro-avatar
generative-art identity-icon nextjs retro-icons
Last synced: about 2 months ago
JSON representation
Create indenticon like Github and Gravatar (retro) avatars.
- Host: GitHub
- URL: https://github.com/microvoid/retro-avatar
- Owner: microvoid
- License: mit
- Created: 2023-03-24T16:15:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-04-07T06:46:51.000Z (over 1 year ago)
- Last Synced: 2024-05-29T00:28:31.711Z (4 months ago)
- Topics: generative-art, identity-icon, nextjs, retro-icons
- Language: TypeScript
- Homepage: https://avatar.microvoid.io/
- Size: 1.11 MB
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Create indenticon-like like Github and Gravatar (retro) avatars.
# Features
- Generate distinctive images for each user, enhancing recognizability.
- Intuitive and easy to recognize.
- Supports various themes.
- All style options can be changed.
# Documentation
For full documentation, visit [website](https://avatar.microvoid.io/)
# Quick Start
You don't need to install any dependencies!
Just replace the `ID_HERE` placeholder with any text.
```
```
for example:
- UserName: [https://avatar.microvoid.io/api/avatar/youking-lib](https://avatar.microvoid.io/api/avatar/youking-lib)
- UserId: [https://avatar.microvoid.io/api/avatar/user-id-xxxx](https://avatar.microvoid.io/api/avatar/user-id-xxxx)
- UserEmail: [https://avatar.microvoid.io/api/avatar/[email protected]](https://avatar.microvoid.io/api/avatar/[email protected])
- ProjectName: [https://avatar.microvoid.io/api/avatar/retro-avatar](https://avatar.microvoid.io/api/avatar/retro-avatar)
# Options
## Themes
| theme | usage | demo |
| ---- | ---- | ---- |
| github | https://avatar.microvoid.io/api/avatar/retro-avatar?t=github |  |
| gravatar | https://avatar.microvoid.io/api/avatar/retro-avatar?t=gravatar |  |
| mono | https://avatar.microvoid.io/api/avatar/retro-avatar?t=mono |  |
| mini | https://avatar.microvoid.io/api/avatar/retro-avatar?t=mini |  |
| window | https://avatar.microvoid.io/api/avatar/retro-avatar?t=window |  |
| mosaic | https://avatar.microvoid.io/api/avatar/retro-avatar?t=mosaic |  |
## Size
| size | usage | demo |
| ---- | ---- | ---- |
| 32 | https://avatar.microvoid.io/api/avatar/retro-avatar?s=32 |  |
| 64 | https://avatar.microvoid.io/api/avatar/retro-avatar?s=64 |  |
The size must be between 16 and 2048, and default to 256.
# Projects
- https://avatar.marktion.cn/ Chinese mirrors enhance the access speed in this area.
# Self host
1. prerequires
retro-avatar rely on the node-canvas project, so you need to install its dependencies on your server.
**for Ubuntu**
```shell
sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
```
**for Fedora**
```shell
sudo yum install gcc-c++ cairo-devel pango-devel libjpeg-turbo-devel giflib-devel
```
For other environments, please refer to [node-cavas](https://github.com/Automattic/node-canvas).
2. clone project
```shell
git clone https://github.com/microvoid/retro-avatar.git
```
3. deploy
```shell
sh deploy.sh
```
4. environment variables (unnecessary)
```shell
# path: retro-avatar/apps/website/.env
# Google Analytics
NEXT_PUBLIC_ANALYTICS_ID=
# Logflare API
LOGFLARE_API_KEY=
LOGFLARE_API_TOKEN=
```
