FROM 0 TO HERO

#1 Clones the project
git clone https://[email protected]/yeldotech/Yeldo%20Board/_git/yeldo-ui-library

#2 If you already have the project put yourself on main and pull from it for latest vers
git pull

#3 Create new branch for the new component
git checkout -b task_55/examplecomponent (change accordingly to board)

#4 If you don't have pnpm on your pc install it first otherwhise go to next step
npm install -g pnpm

#5 Install dependencies
pnpm i

#6 Create a component folder and start developing

#7 Help yourself creating a page for the component for testing how it looks by adding it to App.tsx

#8 Write unit test and check for 100% coverage
pnpm run test

#9 Add the component to the exports file (library.ts) following other "templates"

#10 Bump version patch in package.json ex from 0.1.0 to 0.1.1

#11 Create pull request

Project structure

In the src folder we can find the following sub-folders:

• components: components of the library divided by folders each one of them should have:
  • Component.tsx: the component itself
  • index.spec.tsx: unit tests for the component
  • index.scss: style of the component
• pages: page files for showcase (1 page for each component)
• mocks: mocks for tests
• services:
  • i18n configuration files for translations
• common: utility files (ex regex or common interfaces)