Skip to content

Commit

Permalink
docs: ASC-12687 - Installation step in README (#28)
Browse files Browse the repository at this point in the history
* fix: ASC-12687 - installation step

* Update README.md
  • Loading branch information
nuipawarit authored May 2, 2023
1 parent 676ded9 commit 201ef12
Show file tree
Hide file tree
Showing 4 changed files with 13,308 additions and 11,784 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Amity Ui-Kit for Web (open-source)

## Getting started

### Installation

Here are the steps to install ui-kit together with another project.

1. git clone [email protected]:AmityCo/Amity-Social-Cloud-UIKit-Web-OpenSource.git
2. cd ./Amity-Social-Cloud-UIKit-Web-OpenSource
3. npm ci
4. npm link
5. npm link ./`<path-to-your-app>`/node_modules/react ./`<path-to-your-app>`/node_modules/react-dom
6. npm run build
7. cd ./`<path-to-your-app>`
8. npm link @amityco/ui-kit-open-source --save

** We need to link react module to react module in destination project so that react is the same instance otherwise we will encounter [issues with react hook](https://medium.com/bbc-product-technology/solving-the-problem-with-npm-link-and-react-hooks-266c832dd019).

### Documentation

Please refer to our online documentation at https://docs.amity.co or contact a Ui-Kit representative at **[email protected]** for support.

## Contributing

See [our contributing guide](https://github.com/EkoCommunications/AmityUiKitWeb/blob/develop/CONTRIBUTING.md)
Loading

0 comments on commit 201ef12

Please sign in to comment.