Hello Alice - UI Core

Overview

• The UI components will be built in the packages/ui-core directory.
• Each component will have a corresponding Story that lives in the same space as the component files.
• The directory structure and naming convention is as follows:

ui-core/
	- component-name/
    	- component-name.tsx
    	- component-name.stories.tsx

• The Stories will be consumed by the living style guide: apps/ui-docs
• To start the development Storybook instance, run this command from the root of the monorepo:

pnpm --filter ui-docs run storybook

• Open Storybook at: localhost:6006

Contributing

• Create a new component following the conventions above
• Use Storybook to develop locally
• Open Pull Request against Dev and have tested and reviewed

Release Schedule

• PRs will merged into Dev will be released to Main on a normal development cycle.
• Main will be were the builds and publishing to NPM happen
  • On main branch, navigate to packages/ui-core
  • Build: pnpm run build (only components are in the build, no Stories)
  • Publish: npm publish --access public
  • TODO: Automate this with Github actions

Consuming the published package

• Add/update the package: yarn add @hello-alice/ui-core
• Import component: import { <ComponentName> } from '@hello-alice/ui-core'

---

TODO:

1. Host the living style guide