🧑🏻🧑🏼🧑🏽🧑🏾🧑🏿
Is an easy-to-use API for generating random avatar and name
- An API to generate random avatars
- Customizable avatars with:
- gender
- skin color
- cloth color
- hair type and color
- beard type and color
- mustache type and color
- accessories such as:
- glasses
- earrings
- body marks such as:
- moles
- scars
- tattoos
- An API to generate random first and lastnames
- Support for English and Persian names
Having at least java-11 on your machine installed would be best.
To build the final jar and optimize the Peoplify for production, run:
./mvnw clean install -DskipTests.To run Peoplify on your machine run:
java -jar target/*.jarthen go to the http://localhost:8585 and see the magic =))
To change port of the application please go to src/main/resources/application.properties and change server.port=8585 to whatever you want
GET http://localhost:8585/api/generate/avatar
As response, you will get a byte array png image
If you want your avatar to be generated by any specific parameters you can pass them as query parameters:
| Parameter | Acceptable Values (case insensitive) |
|---|---|
| size | Integer |
| gender | male, female |
| avatarColor | black, brown, nude, pink, white, yellow |
| faceType | normal, freckles |
| hairType | semi_bald(male), long_afro(female), short_afro(male), pony_tail(female), center_part(male), side_part(male), cornrows(male), bald(male) |
| hairColor | black, blonde, blue, brown, orange, pink, white |
| beardType(male) | goat_patch, goatee, fork, chin_trap, garibaldi, ned_kelly |
| beardColor(male) | black, blonde, blue, brown, orange, pink, white |
| mustacheType | chevron, walrus, handlebar, poirot |
| mustacheColor | black, blonde, blue, brown, orange, pink, white |
| clothColor | black, blue, gray, green, orange, pink, purple, red, white, yellow |
| glassesType | round, cat_eye |
| glassesColor | black, blue, gray, green, orange, pink, purple, red, white, yellow |
GET http://localhost:8585/api/generate/name
RESPONSE
{
"first_name": {
"name":"Sonny",
"gender":"male",
"language":"english"
},
"last_name": {
"name":"Rounsville",
"gender":null,
"language":"english"
}
}| Parameter | Acceptable Values (case insensitive) |
|---|---|
| gender | male, female |
| language | english, persian |
Peoplify is developed by Soroush Shemshadi as Back-End developer, Shayan Mahjoub as Front-End developers and contributors.
If you want to contribute on this project, Please read the contribution guide.
To see the changes in different versions of badgify, you can read the release notes.
If you encounter a bug or vulnerability, please read the issue policy.
A great thanks to our wonderful designer @sarahrajabi for designing the website.
And thanks to all the contributors, the people who reported the bugs and all those who made it possible for us to provide this great piece of software.