NEA Design System

Shared NEA UI primitives, theme tokens, and Storybook documentation.

Local Development

Use Node 22 for local development:

nvm use

npm install
npm test
npm run build
npm run storybook

Publishing

This package is built to dist/ before publish. The public package entry points are the compiled files in dist, not the raw src files.

One-time setup:

1. Create the npm scope/package you want to publish to. This repo is currently configured for @neasg/design-system, so the @neasg scope must exist in npm.
2. Add a GitHub Actions secret named NPM_TOKEN with publish access to that scope.

Release flow:

1. Make sure all your changes are committed and pushed to main.
2. Bump the version — this updates package.json and creates a git tag automatically:

   npm version patch   # 0.2.0 → 0.2.1
   npm version minor   # 0.2.0 → 0.3.0
   npm version major   # 0.2.0 → 1.0.0
   npm version 0.5.0   # set an exact version

3. Push the commit and tag together:

   git push origin main --follow-tags

4. The v* tag triggers .github/workflows/publish.yml, which runs tests, builds, and publishes to npm.

Note: If GPG signing fails on step 2, you can do it manually:

npm version 0.2.0 --no-git-tag-version
git add package.json package-lock.json
git commit -m "0.2.0"
git tag v0.2.0
git push origin main --follow-tags

Storybook Deployment

vercel.json is configured to deploy the built Storybook static site:

• Install command: npm ci
• Build command: npm run build-storybook
• Output directory: storybook-static

One-time Vercel setup:

1. Import this GitHub repo into Vercel.
2. Let Vercel use the repo root as the project root.
3. Keep the build settings from vercel.json.

After that, every push to the tracked branch deploys Storybook automatically in Vercel.