-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: ASC-12687 - Installation step in README (#28)
* fix: ASC-12687 - installation step * Update README.md
- Loading branch information
1 parent
676ded9
commit 201ef12
Showing
4 changed files
with
13,308 additions
and
11,784 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
Oops, something went wrong.