Giter VIP home page Giter VIP logo

avataaars-rb's Introduction

Avataaars for Ruby

Ruby wrapper library to call to Avataaars React component using NodeJS

Kudos to Pablo Stanley for creating the assets, Fang-Pen Lin for the React component and the Schmooze project for which the Ruby<->NodeJS integration was based on.

Installation

Add this line to your application's Gemfile:

gem 'avataaars'

Avataaars React component

npm install avataaars react react-dom

Usage

# Create an Avataaars SVG using the default attributes
avatar = Avataaars.new.create_avatar

# Create an Avataaars SVG using specific attributes
avatar = Avataaars.new(
  avatar_style: 'Circle',
  top_type: 'ShortHairShortFlat',
  hair_color: 'BrownDark',
  accessories_type: 'Round',
  facial_hair_type: 'BeardMedium',
  facial_hair_color: 'Auburn',
  clothe_type: 'Hoodie',
  clothe_color: 'PastelGreen',
  eye_type: 'Surprised',
  eyebrow_type: 'UpDown',
  mouth_type: 'Disbelief',
  skin_color: 'Brown'
).create_avatar

# When your node install is not in the PWD
avatar = Avataaars.new(root_path: 'some/other/path').create_avatar 

Yeah, but why not just write it all in Ruby

๐Ÿ˜• This was considered but was more of a maintenance issue. Given the assets/React component haven't seen much in the way of changes I may re-write the gem at some time to just implement the avatar creation. Upside would be a pretty massive speed boost as calling out to NodeJS like this isn't super performant.

License

The gem is available as open source under the terms of the MIT License.

avataaars-rb's People

Contributors

abrom avatar

Stargazers

Gerald Bauer avatar Tanay Lakhani avatar jim avatar

Watchers

James Cloos avatar  avatar Brendon Low avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.