4.8.1 • Published 5 months ago

@amityco/ui-kit-open-source v4.8.1

Weekly downloads
-
License
LGPL-2.1-only
Repository
-
Last release
5 months ago

Amity UI-Kit for Web (Open-Source)

Prerequisites

Before getting started, ensure that you have the following prerequisites installed on your system:

  • Node.js LTS version (currently version 20)
  • pnpm 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.

If you require further assistance or have any questions, please don't hesitate to contact our dedicated UI-Kit support team at developers@amity.co. We are here to help you make the most of the Amity UI-Kit.

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 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.

3.11.4

11 months ago

3.13.1

6 months ago

3.11.3

11 months ago

3.11.6

9 months ago

3.11.5

10 months ago

3.11.8

8 months ago

3.11.7

8 months ago

3.12.0

8 months ago

4.4.1

7 months ago

4.4.0

7 months ago

4.6.1

6 months ago

4.4.2

7 months ago

4.2.1

8 months ago

4.2.0

8 months ago

4.0.2

9 months ago

4.0.0-beta.18

11 months ago

4.8.1

5 months ago

4.8.0

5 months ago

3.13.0

6 months ago

3.11.2

11 months ago

3.11.1

11 months ago

4.7.0

6 months ago

4.1.0

9 months ago

4.3.0

8 months ago

4.0.0-beta.17

12 months ago

4.0.0-beta.16

12 months ago

3.11.0

12 months ago

3.10.3

1 year ago

4.0.0-beta.15

1 year ago

3.10.1

1 year ago

3.10.0

1 year ago

4.0.0-beta.13

1 year ago

3.10.2

1 year ago

4.0.0-beta.12

1 year ago

3.9.0

1 year ago

4.0.0-beta.8

1 year ago

4.0.0-beta.7

1 year ago

4.0.0-beta.6

1 year ago

4.0.0-beta.5

1 year ago

4.0.0-beta.11

1 year ago

3.8.0

1 year ago

4.0.0-beta.10

1 year ago

3.7.0

1 year ago

3.6.0

1 year ago

4.0.0-beta.9

1 year ago

4.0.0-beta.4

1 year ago

4.0.0-beta.3

1 year ago

3.5.0

1 year ago

4.0.0-beta.2

2 years ago

4.0.0-beta.1

2 years ago

4.0.0-beta.0

2 years ago

4.0.0

2 years ago

3.2.4

2 years ago

3.2.3

2 years ago

3.2.2

2 years ago

3.1.2

2 years ago

3.1.1

2 years ago