https://github.com/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
https://github.com/Yei-Linux/GamiUI

atomic-design chromatic classnames emotion react storybook typescript

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/Yei-Linux/GamiUI
• Owner: Yei-Linux
• Created: 2021-05-10T03:02:46.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-07T14:27:22.000Z (about 2 years ago)
• Last Synced: 2025-01-25T09:24:23.989Z (11 months ago)
• Topics: atomic-design, chromatic, classnames, emotion, react, storybook, typescript
• Language: TypeScript
• Homepage: https://www.gamiui.com
• Size: 10 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  

    

    
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:

  


  ```js

  npm i @gamiui/standard

  ```

- **2. Provider Setup**:

  

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

  


  ```jsx

  import React from "react";

  import { ThemeGamification } from "@gamiui/standard";

  export const App = () => {

    return (

       

        

      

    );

  };

  ```

- **3. Start using a component**:

  

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

  


  ```jsx

    import React from "react";

    import { Button } from '@gamiui/standard'

    export const App = () => {

    return (

       

        GamiUI

      

    );

  };

  ```

## **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