Skip to content

πŸ§‘πŸ»πŸ§‘πŸΌπŸ§‘πŸ½πŸ§‘πŸΎπŸ§‘πŸΏ A random people (avatar and name) generator

License

Notifications You must be signed in to change notification settings

siloxa/peoplify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

peoplify

πŸ§‘πŸ»πŸ§‘πŸΌπŸ§‘πŸ½πŸ§‘πŸΎπŸ§‘πŸΏ

Peoplify

Is an easy-to-use API for generating random avatar and name

What Is In V1.0.0

  • 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

Contents

Install and Run

Requirements

Having at least java-11 on your machine installed would be best.

Build

To build the final jar and optimize the Peoplify for production, run:

./mvnw clean install -DskipTests.

Run

To run Peoplify on your machine run:

java -jar target/*.jar

then 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

APIs

Avatar

GET http://localhost:8585/api/generate/avatar

As response, you will get a byte array png image

Parameters

If you want your avatar to be generated by any specific parameters you can pass them as query parameters:

ParameterAcceptable Values (case insensitive)
sizeInteger
gendermale, female
avatarColorblack, brown, nude, pink, white, yellow
faceTypenormal, freckles
hairTypesemi_bald(male), long_afro(female), short_afro(male), pony_tail(female), center_part(male), side_part(male), cornrows(male), bald(male)
hairColorblack, 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
mustacheTypechevron, walrus, handlebar, poirot
mustacheColorblack, blonde, blue, brown, orange, pink, white
clothColorblack, blue, gray, green, orange, pink, purple, red, white, yellow
glassesTyperound, cat_eye
glassesColorblack, blue, gray, green, orange, pink, purple, red, white, yellow

Name

GET http://localhost:8585/api/generate/name

RESPONSE

{
  "first_name": {
    "name":"Sonny",
    "gender":"male",
    "language":"english"
  },
  "last_name": {
    "name":"Rounsville",
    "gender":null,
    "language":"english"
  }
}

Parameters

ParameterAcceptable Values (case insensitive)
gendermale, female
languageenglish, persian

Authors

Peoplify is developed by Soroush Shemshadi as Back-End developer, Shayan Mahjoub as Front-End developers and contributors.

Contribution

If you want to contribute on this project, Please read the contribution guide.

Releases

To see the changes in different versions of badgify, you can read the release notes.

Issues

If you encounter a bug or vulnerability, please read the issue policy.

Acknowledgement

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.

About

πŸ§‘πŸ»πŸ§‘πŸΌπŸ§‘πŸ½πŸ§‘πŸΎπŸ§‘πŸΏ A random people (avatar and name) generator

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published