Yei-Linux/GamiUI

GamiUI is an UI Library provides a series of customizables components to use on apps wich use a gamification orientation. NPM: https://www.npmjs.com/package/@gamiui/standard. Storybook : https://6098a5391a29200039e99041-irdhvapfqc.chromatic.com/?path=/docs/atoms-avatar-%F0%9F%9F%A2--one

GamiUI

Installation

The easiest way to get started with GamiUI is to use the global installation. Which means that all the components are imported from a single package.

Follow the steps below to install all GamiUI components:

• 1. Install Packages:

  To install GamiUI, run one of the following commands in your terminal:
  

  npm i @gamiui/standard

• 2. Provider Setup:

  It is essential to add the GamiUIProvider at the root of your application:
  

  import React from "react";
  import { ThemeGamification } from "@gamiui/standard";
  
  export const App = () => {
    return (
      <ThemeGamification> 
        <YourApplication />
      </ThemeGamification>
    );
  };

• 3. Start using a component:

  To install GamiUI, run one of the following commands in your terminal:
  

    import React from "react";
    import { Button } from '@gamiui/standard'
  
    export const App = () => {
    return (
      <Button> 
        GamiUI
      </Button>
    );
  };

Framework Guides

GamiUI is compatible with your preferred framework. We have compiled comprehensive, step-by-step tutorials for the following frameworks:

• 1. Nextjs
• 2. Vite