https://github.com/halilatilla/getea

If you need a random fancy avatar or some kind of icon, check this out!
https://github.com/halilatilla/getea

avatar avatar-generator avatar-placeholder chromatic placeholder-avatars profile-picture react storybook svg svgr

Last synced: about 2 months ago
JSON representation

If you need a random fancy avatar or some kind of icon, check this out!

• Host: GitHub
• URL: https://github.com/halilatilla/getea
• Owner: halilatilla
• License: mit
• Created: 2022-03-23T19:46:35.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-29T05:51:36.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T13:59:35.005Z (3 months ago)
• Topics: avatar, avatar-generator, avatar-placeholder, chromatic, placeholder-avatars, profile-picture, react, storybook, svg, svgr
• Language: TypeScript
• Homepage: https://623f3bfd0693ca003a65bbce-ibzuupnjss.chromatic.com/
• Size: 2.73 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![npm](https://img.shields.io/npm/v/getea?label=npm) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/halilatilla/getea?label=code%20size)

[![GitHub license](https://img.shields.io/github/license/halilatilla/getea?label=license)](https://github.com/halilatilla/getea/blob/main/LICENSE)

# Get Empty Avatar [Live Demo](https://623f3bfd0693ca003a65bbce-ibzuupnjss.chromatic.com/)

### **Create unique, stylish avatars or icons effortlessly!**

![ezgif com-gif-maker](https://user-images.githubusercontent.com/27916419/160250550-5c5c5e92-6326-47ff-a090-92ac9cc974a9.gif)




## **📦 Installation**

Install **`getea`** using npm:

```

npm install getea

```

Alternatively, use yarn:

```

yarn add getea

```




## **📚 Usage**

### **React**

```

import { GetFancyAvatar } from 'getea';

function App() {

  return ;

}

```




## **⚙️ Props List**

| Name | Type | Default | Description |

| --- | --- | --- | --- |

| size | number | 72 | Sets the size of the avatar. |

| bgColor | string | "#E5E5E5" | Sets the background color of the avatar. |

| border | Array | {size: 2, color: "#eeeeee", radius: 50, style: 'solid'} | Configures the border properties of the avatar. |




## **🚀 Development**

We warmly welcome and appreciate pull requests. Choose an issue and help us improve!

To install and work on **`getea`** locally, follow these steps:

1. Clone the repository:

```

git clone https://github.com/halilatilla/getea.git

```

2. Navigate to the project directory:

```

cd getea

```

3. Install dependencies:

```

npm install

```

4. Start the development server:

```

yarn start

# or

npm start

```

The development server can be accessed at **[http://localhost:3000/](http://localhost:3000/)**.

5. Launch Storybook:

```

yarn storybook

# or

npm run storybook

```

Storybook will be available at **[http://localhost:6006/](http://localhost:6006/)**.




## **✍️ Authors**

- **[@halilatilla](https://github.com/halilatilla)**




## **📄 License**

This project is licensed under the MIT License.