@rg-npmjs-dev/rg-amity-social-ui
v2.15.12
Published
REALM Global Amity Social UI Kit - Fork
Downloads
111
Readme
rg-amity-social-uikit: Amity UI Social Kit - Fork
Getting started
Installation
- git clone https://github.com/R-G-Social-UIKit/social.git
- cd ./rg-amity-social-uikit
- make sure you are in prod branch
npm ci
ornpm ci ---legacy-peer-deps
if you get an error- update .env with api key and region, users can be mocked/fake names
Develop locally in parallel with a product
- install yalc globall if you don't have it
npm i yalc -g
- build the ui kit:
npm run build
yalc publish
in rg-amity-social-uikit directoryyalc add @rg-npmjs-dev/rg-amity-social-ui
in adminsite reponpm install
in FE repo if this is the first time you've added it (use --legacy-peer-deps if error)- Please branch from prod, and work in your own branch.
- When you are done,
yalc remove --all
(from the adminsite folder) (PLEASE ENSURE YOU DON'T COMMIT TO FE WITH THE YALC REFERENCE PRESENT) YALC documentation: https://github.com/wclr/yalc
Develop with Storybook
npm run storybook
- http://localhost:6006/ to view sotrybook and update UI
- Please branch from prod, and work in your own branch.
Publish changes to NPM
- Update the version number in package.json (check npm or prod branch to ensure correct version)
- stage and commit all changes.
- merge changes into prod branch
- open prod brach
npm run build
npm publish
(only [email protected] team members currently have npm credentials) Once published, rebuild product FE enviroment, and UI kit changes should be pulled in.
Documentation
Please refer to our online documentation at https://docs.amity.co or contact a Ui-Kit representative at [email protected] for support.