Skip to content

An api for generating user profile avatars based on the name specified with more customization

Notifications You must be signed in to change notification settings

Ysn4Irix/oneAvatar

Repository files navigation

oneAvatar

oneAvatar

An api for generating user profile avatars based on the name specified with more customization build using Node.js

Give as a Star 🌟

Installation

API requires Node.js v14+ to run.

Clone, Install the dependencies and start.

git clone https://github.com/Ysn4Irix/oneAvatar.git
cd oneAvatar
npm install
npm start or npm run dev

Usage

Generating a Profile Avatar

GET /api/v1/?size=256&background=random&bold=yes&rounded=yes&fullname=ysn4irix

Replacing Query Parameters

  1. size : The size of the avatar either 256 or 512
  2. background : Background color of the avatar either a hex code or your can put random to get random color
  3. bold : text can bold (yes) or not (no)
  4. rounded : avatar can be a circle (yes) or a rectangle (no)
  5. fullname : fullname of user if there is a space we subtracts first letter of the first word and the last word otherwise we subtracts the first & second letter

Example response

oneAvatar

License

MIT

About

An api for generating user profile avatars based on the name specified with more customization

Topics

Resources

Stars

Watchers

Forks