This repository contains our design system component. The main reason that we created this repository was to unify our shared components into a single source and make development easier without having to build atomic components. For development, engineers must install the following apps:
- Node JS (v20)
- PNPM
- Makefile
After you have installed the library, below are the steps for running the apps on your local system:
-
Clone the Repository:
Before cloning the repository, make sure your local machine has previously installed the github; if not, you may read this confluence to install the git.git clone https://github.com/FIT-HUB-INDONESIA/fithub-design-system.git cd fithub-design-system -
Install Dependencies & Husky:
After you clone the repository, the dependency is not immediately installed; you may install the mandatory dependencies and husky by running this command on your terminal.make init-dev
-
Run The Storybook:
For running the storybook you can run this command; by default we will copy the development env and also running the apps using pnpm.pnpm run storybook
-
Open In Your Browser:
You can visit http://localhost:6006 to see the app in browser.
After development, we normally need to look over the code before committing the changes; to avoid committing buggy code, use this command before commit.
make check-code