Supported platforms

• web

development

after clone the project please run this command

yarn add 

or

npm install

for run the dev server and see the results on the browser run

npm run storybook

or

yarn storybook

Contributing

• all components exist in src/components folder you can add your own components and export it in index.js
• please check folder structure and use the same structure for new components,
• run yarn buid:lib to re-generate dist.
• run yarn release to build & publish on npm.

How to use

make sure you have configured .npmrc & have GOKI_NPM_TOKEN in your environment variables.

• in order to create an access token, open your gitlab profile & go to Settings > Personal Access Tokens & create a new token with read registry (or api) scope.
• your account should have access to the backpack registry project

# .npmrc
//gitlab.com/api/v4/projects/:_authToken="${GOKI_NPM_TOKEN}"
//gitlab.com/api/v4/projects/31892934/packages/npm/:_authToken="${GOKI_NPM_TOKEN}"
@backpack:registry=https://gitlab.com/api/v4/projects/31892934/packages/npm/
always-auth=true

and install the package:

yarn add @backpack/web-uikit

or

npm install @backpack/web-uikit

How to use it in your project

• import and use the component you want in your react app also you can check the example app in exmaple

import {Button} from '@backpack/web-uikit'

const icon = (
    <Button
        onClick={() => { }}
        disabled={false}
        loading={false}
        type="primary">
        Primary
    </Button>
)

Publish Storybook

first you need to build the storybook, run

yarn build-storybook

use chromatic to publish the storybook

yarn chromatic

then you can see the result and share it in the chromatic