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
Execute Project
-
Version of node and npm. Node: 15.3.0 Npm: 7.0.14
-
Install dependencies to execute project. Execute on root project npm run install-deps
-
Publish project to npm of @gamiui/standard. First login on npm Then change version Finally execute this command script: npm run publishfinal:gami-ui