Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clydedz/give-me-an-avatar-npm
Gets a random avatar URL from a collection of different avatar generation services.
https://github.com/clydedz/give-me-an-avatar-npm
avatar avatar-generator avatar-placeholder avatar-service azure-devops coverage github-package-registry github-packages javascript-library npm npm-package nyc random-avatar ts-mocha typescript
Last synced: 6 days ago
JSON representation
Gets a random avatar URL from a collection of different avatar generation services.
- Host: GitHub
- URL: https://github.com/clydedz/give-me-an-avatar-npm
- Owner: ClydeDz
- License: mit
- Created: 2020-12-12T06:51:02.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-17T09:32:36.000Z (about 4 years ago)
- Last Synced: 2024-08-09T03:28:51.914Z (5 months ago)
- Topics: avatar, avatar-generator, avatar-placeholder, avatar-service, azure-devops, coverage, github-package-registry, github-packages, javascript-library, npm, npm-package, nyc, random-avatar, ts-mocha, typescript
- Language: TypeScript
- Homepage: https://bit.ly/give-me-an-avatar
- Size: 296 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Give Me an Avatar
Gets a random avatar URL from a collection of different avatar generation services.
[](https://clydedsouza.visualstudio.com/Give%20Me%20an%20Avatar%20npm/_build/latest?definitionId=32)
[](https://clydedsouza.visualstudio.com/Give%20Me%20an%20Avatar%20npm/_build?definitionId=32)
[](https://sonarcloud.io/dashboard?id=ClydeDz_give-me-an-avatar-npm)
[](https://sonarcloud.io/dashboard?id=ClydeDz_give-me-an-avatar-npm)
[](https://bit.ly/give-me-an-avatar)
[](https://ctt.ac/k925T)
## Usage
Install the package from npm using the following command.
```NPM Config
npm i give-me-an-avatar
```
After installing, simply import Give Me an Avatar in your file.
```javascript
const avatars = require("give-me-an-avatar");
```
Consume the `giveMeAnAvatar()` API to get an avatar URL that you can use directly as an image. You can either call the method without any parameters or supply the settings object to customize your avatar a bit. All settings are pretty self-explanatory and are not mandatory. For example:
```javascript
let image = avatars.giveMeAnAvatar({
Name: "John Smith",
Size: 128
});
```
The image variable will have the avatar image URL.
If you'd like to consume this package via a CDN, please see [this demo](https://github.com/ClydeDz/give-me-an-avatar-npm/blob/main/demo/index.html).
## Supported avatar services
| Service | Avatar example |
|--------------------------------------------|------------------------------------------------------|
| [placeholder.com](https://placeholder.com) |  |
| [placeimg.com](https://placeimg.com) |  |
| [placekitten.com](https://placekitten.com) |  |
| [dummyimage.com](https://dummyimage.com/) |  |
| [loremflickr.com](https://loremflickr.com) |  |
| [baconmockup.com](https://baconmockup.com) |  |
| [placebeard.it](https://placebeard.it) |  |
| [fakeimg.pl](https://fakeimg.pl) |  |
| [thispersondoesnotexist.com](https://thispersondoesnotexist.com/) | 
|
| [picsum.photos](https://picsum.photos/) |  |
| [fillmurray.com](https://www.fillmurray.com) |  |
| [placecage.com](https://www.placecage.com) |  |
| [stevensegallery.com](https://www.stevensegallery.com) |  |
| [gravatar.com](https://www.gravatar.com) |  |
| [ui-avatars.com](https://www.ui-avatars.com) |  |
| [generative-placeholders.glitch.me](https://generative-placeholders.glitch.me) |  |
| [robohash.org](https://robohash.org) |     |
| [avatars.dicebear.com](https://avatars.dicebear.com) |       |
| [avatar.uimaterial.com](https://avatar.uimaterial.com) |     |
## Notes
* I'm not using [avataaars](https://avataaars.io/) separately since [avatars.dicebear.com](https://avatars.dicebear.com) includes avataaars.
* Placekitten image might appear broken at times in the table above, however, the image service itself runs fine.
## Credits
- All the avatar services used in this npm package are outlined in the table above.
- Package logo created using [AutoDraw](https://www.autodraw.com/).
- This NPM package is developed by [Clyde D'Souza](https://twitter.com/clydedz).