Ada (react)

The React implementation of the Ada design system for Peopled.

Documentation can be found in the github repository under /docs.

Development

For local development, you only need to run this command:

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

Publishing

Pull Request Guidelines

Every PR should include:

• Tests - Add unit tests for new components or functionality
• Storybook Stories - Add Storybook stories to document and showcase the component

Release Workflow

1. Create a feature branch

   git checkout -b your-name/PPLD-123-your-feature-name

2. Make your changes

   • Add your code changes
   • Add unit tests (.test.tsx files)
   • Add Storybook stories (.stories.tsx files)
   • Make sure you updated the index file to export your component
   • Commit your changes

3. Update the version

   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)

   This will automatically update package.json 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 main
   • Run npm publish (must be authenticated with NPM) to deploy the latest version