-
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.
Merge remote-tracking branch 'upstream/develop' into release/v4.0.0-b…
…eta.13
- Loading branch information
Showing
40 changed files
with
571 additions
and
229 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 |
---|---|---|
|
@@ -2,135 +2,20 @@ | |
|
||
## Prerequisites | ||
|
||
Before getting started, ensure that you have the following prerequisites installed on your system: | ||
Before starting to work, please read the following instructions. | ||
https://ekoapp.atlassian.net/wiki/spaces/UP/pages/2443706407/ASC+Web+UIKit+V4+Governance | ||
|
||
If you have any questions, please ask / discuss with the team. | ||
|
||
### Installation | ||
|
||
- [Node.js](https://nodejs.org/) LTS version (currently version 20) | ||
- [pnpm](https://pnpm.io/) version 8 | ||
|
||
## How to install PNPM (Optional) | ||
|
||
``` | ||
corepack enable pnpm | ||
``` | ||
|
||
Ref: https://pnpm.io/installation#using-corepack | ||
|
||
## Running Storybook (Optional) | ||
|
||
To run Storybook and view the UI components in isolation, follow these steps: | ||
|
||
1. Clone the Amity UI-Kit repository: | ||
|
||
``` | ||
git clone https://github.com/AmityCo/Amity-Social-Cloud-UIKit-Web-OpenSource.git | ||
``` | ||
|
||
2. Navigate to the cloned repository's directory: | ||
|
||
``` | ||
cd Amity-Social-Cloud-UIKit-Web-OpenSource | ||
``` | ||
|
||
3. Install the dependencies using pnpm: | ||
|
||
``` | ||
pnpm install | ||
``` | ||
|
||
4. Create a `.env` file at the root of the project with the following content: | ||
|
||
``` | ||
STORYBOOK_API_REGION=<API_REGION> | ||
STORYBOOK_API_KEY=<API_KEY> | ||
``` | ||
|
||
Replace `<API_REGION>` and `<API_KEY>` with your actual credentials. | ||
|
||
5. Run Storybook: | ||
|
||
``` | ||
pnpm run storybook | ||
``` | ||
|
||
6. Open your browser and navigate to `http://localhost:6006` to view the Storybook interface. | ||
|
||
## Installation | ||
|
||
To install the Amity UI-Kit together with another project, follow these steps: | ||
|
||
1. Clone the repository using the following command: | ||
|
||
``` | ||
git clone https://github.com/AmityCo/Amity-Social-Cloud-UIKit-Web-OpenSource.git | ||
``` | ||
|
||
2. Navigate to the cloned repository's directory: | ||
|
||
``` | ||
cd ./Amity-Social-Cloud-UIKit-Web-OpenSource | ||
``` | ||
|
||
3. Install the dependencies using pnpm: | ||
|
||
``` | ||
pnpm install | ||
``` | ||
|
||
4. Build the project: | ||
|
||
``` | ||
pnpm run build | ||
``` | ||
|
||
5. Pack the project | ||
|
||
``` | ||
pnpm pack | ||
``` | ||
|
||
6. Navigate to your application's directory: | ||
|
||
``` | ||
cd <path-to-your-app> | ||
``` | ||
|
||
7. Install the Amity UI-Kit to your application using one of the following package managers: | ||
- NPM: | ||
``` | ||
npm i file:<path-to-amity-ui-kit-repository>/<path-to-tgz-file> --save | ||
``` | ||
- Yarn (Classic): | ||
``` | ||
yarn add file:<path-to-amity-ui-kit-repository>/<path-to-tgz-file> | ||
``` | ||
- PNPM: | ||
``` | ||
pnpm i file:<path-to-amity-ui-kit-repository>/<path-to-tgz-file> | ||
``` | ||
## Documentation | ||
For detailed information and guidance on using the Amity UI-Kit, please refer to our comprehensive online documentation available at [https://docs.amity.co](https://docs.amity.co). | ||
If you require further assistance or have any questions, please don't hesitate to contact our dedicated UI-Kit support team at **[email protected]**. We are here to help you make the most of the Amity UI-Kit. | ||
Please refer to our online documentation at https://docs.amity.co or contact a Ui-Kit representative at \* \*[email protected]** for support. | ||
|
||
## Contributing | ||
|
||
We welcome contributions from the community to help improve and enhance the Amity UI-Kit. If you are interested in contributing to this project, please review our [contributing guide](https://github.com/AmityCo/Amity-Social-Cloud-UIKit-Web-OpenSource/blob/develop/contributing.md) for guidelines and best practices. | ||
Thank you for choosing the Amity UI-Kit for your web development needs! | ||
### FAQ | ||
Q: I tried to run `pnpm build` and it throws a types error. | ||
A: Try to structure your project to be like this: | ||
``` | ||
- your_app | ||
- src | ||
- Amity-Social-Cloud-UIKit-Web-OpenSource | ||
- src | ||
``` | ||
Q: The modifications I made to the code do not appear to be applied. | ||
A: Please attempt to execute `npm cache clean` or `npm cache clean --force` to resolve this issue. | ||
See [our contributing guide](https://github.com/EkoCommunications/AmityUiKitWeb/blob/develop/CONTRIBUTING.md) |
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
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
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
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
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
Oops, something went wrong.