https://github.com/sixoverground/icotar
A free colorful icon avatar generator.
https://github.com/sixoverground/icotar
avatar avatar-generator avatar-placeholder avatar-service avatars icon icons png svg
Last synced: 6 months ago
JSON representation
A free colorful icon avatar generator.
- Host: GitHub
- URL: https://github.com/sixoverground/icotar
- Owner: sixoverground
- License: mit
- Created: 2019-02-21T14:30:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T14:18:54.000Z (over 2 years ago)
- Last Synced: 2024-05-01T11:34:17.464Z (about 1 year ago)
- Topics: avatar, avatar-generator, avatar-placeholder, avatar-service, avatars, icon, icons, png, svg
- Language: JavaScript
- Homepage: https://icotar.com
- Size: 686 KB
- Stars: 124
- Watchers: 2
- Forks: 10
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Icotar
Colorful Icon Avatars
Icotar generates simple, playful avatars for your app or website. Based on the lovable avatars from Yik Yak, each avatar consists of a colorful background and a recognizable symbol. All colors and icons are hand-picked from [Material Design](https://material.io/).
Setting up Icotars is easy with a simple and free HTTP API that you can use without an account!
### Colorful Initials Avatars (NEW!)
[Read initials documentation](https://github.com/sixoverground/icotar/wiki/initials)
Generate colorful, customizable initials for any name on the fly!
## How to Use Icotar
Icotar images may be requested just like a normal image. Our HTTP-API is based on the system built by the fine folks at Gravatar.
#### Base Request
The most basic image request URL looks like this:
```
https://icotar.com/avatar/:hash
```
Where `:hash` is replaced with anything you like. But **don't** use any sensitive or personal data here! For example, here is a base URL:
```
https://icotar.com/avatar/craig
```
#### File Types
All avatars are served as SVG files by default. If you require a **file-type extension** then you can add an optional `.svg` extension to that URL:
```
https://icotar.com/avatar/craig.svg
```
Icotar also supports PNG files:
```
https://icotar.com/avatar/craig.png
```
#### Size
By default, PNG images are presented at 80px by 80px if no size parameter is supplied. You may request a specific image size, which will be dynamically delivered from Icotar by using the `s=` or `size=` parameter and passing a single pixel dimension (since Icotars are square):
```
https://icotar.com/avatar/craig.png?s=200
```
You may request images anywhere from **1px up to 1024px**.
#### Secure Requests
All URL requests should start with HTTPS.
## License
[MIT License](https://opensource.org/licenses/MIT)
Made with ❤️ by [Six Overground](http://sixoverground.com)