Skip to content

Latest commit

 

History

History
105 lines (67 loc) · 2.04 KB

README.md

File metadata and controls

105 lines (67 loc) · 2.04 KB

npm GitHub code size in bytes GitHub license

Get Empty Avatar Live Demo

Create unique, stylish avatars or icons effortlessly!

ezgif com-gif-maker


📦 Installation

Install getea using npm:

npm install getea

Alternatively, use yarn:

yarn add getea

📚 Usage

React

import { GetFancyAvatar } from 'getea';

function App() {
  return <GetFancyAvatar />;
}

⚙️ 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
  1. Navigate to the project directory:
cd getea
  1. Install dependencies:
npm install
  1. Start the development server:
yarn start
# or
npm start

The development server can be accessed at http://localhost:3000/.

  1. Launch Storybook:
yarn storybook
# or
npm run storybook

Storybook will be available at http://localhost:6006/.


✍️ Authors


📄 License

This project is licensed under the MIT License.