Ada React UI Components
npm install @peopled/ada-react> The React implementation of the Ada design system for Peopled.
Documentation can be found in the github repository under /docs.
For local development, you only need to run this command:
``bash`
npm run dev
- npm run dev does two things:
- Runs the main development server (vite), for bundling CSS and React components
- Runs Storybook for live component development and documentation as a UI
Every PR should include:
- Tests - Add unit tests for new components or functionality
- Storybook Stories - Add Storybook stories to document and showcase the component
1. Create a feature branch
`bash`
git checkout -b your-name/PPLD-123-your-feature-name
2. Make your changes
- Add your code changes
- Add unit tests (.test.tsx files).stories.tsx
- Add Storybook stories ( files)
- Make sure you updated the index file to export your component
- Commit your changes
3. Update the version
`bash`
npm version patch # For bug fixes (0.0.x)
npm version minor # For new features (0.x.0)
npm version major # For breaking changes (x.0.0)
package.json
This will automatically update and create a git tag.
4. Run npm run build to make sure the lockfiles are up to date
5. Create a Pull Request
- Push your branch with the version bump included
- Create a PR to the main branch
- Ensure all tests pass and Storybook stories are working
6. After PR is merged
- Checkout the main branch locally and fetch the latest
- git checkout main && git pull origin mainnpm publish` (must be authenticated with NPM) to deploy the latest version
- Run