Important: before participating in our community, please read our code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
Please refer to the Amity contribution guide
- A bug or feature you want to work on!
- A GitHub account.
- A copy of our Ui-Kit. See the next steps for instructions.
- Node, which runs JavaScript locally. Current or LTS will both work.
- A fontawesome token, from a paid subscription.
- An editor.
- Install node using the version you downloaded from nodejs.org.
- Open a terminal.
- Make a fork—your own copy—of our Ui-Kit on your GitHub account, then make a clone—a local copy—on your computer. (Here are some step-by-step instructions).
- Change to the folder you made while cloning your local copy:
cd AmityUiKitWeb - Add to your fontawesome token to your env:
export NPM_FONT_AWESOME_TOKEN=<your_fontawesome_token> - Install dependencies:
npm ci - Make sure everything builds and tests pass:
npm run storybook - Open your working folder in your editor.
- Follow the directions below to add and debug a test.
Storybook is a web application which provides a safe and independent environment to build isolated, testable components and user journey.
In the context of Ui-Kit, we use it in development phase to deploy faster, QA phase to test in isolated context, and production phase as documentation and show-case tool.
When creating a component, simply create a Component.stories.js file containing your storybook stories. More on how to write stories here. We have installed the plugins controls and actions, so make sure you use them wisely.