Skip to content

Repository files navigation

Hackney Design System.

Publish documentation

Run unit tests

The Hackney Design System contains everything you need to build user interfaces for Hackney platforms and services.

See the full documentation


We have a Codepen for you to quickly experiment with code samples from the design system, and a prototype kit for making flows to share with stakeholders or use in research.

We have starter kits for using the design system in production.


Contributing

We use a feature-branching strategy. Make your pull requests to the develop branch. See docs/contributing/git-workflow.md for release and branch-sync policy.

See the full contributor guidance

npm releases

  • Pushes run unit tests and a production dependency audit (see tests.yml).
  • Publishing uses npm trusted publishers (OIDC) via publish-npm.yml — no long-lived NPM_TOKEN in the publish workflows.
  • Maintainers can publish a prerelease to npm @next when ready (publish-npm.yml, channel next — requires approval on the npm-prerelease environment).
  • Merging a Release Please PR creates a GitHub Release; publish-npm.yml then publishes to npm latest (via the npm-release environment). prepublishOnly validates the npm pack contents only (no docs or dist build).
  • Use publish-npm.yml (channel latest) for manual latest publishes when the automatic path did not run (also uses npm-release environment approval).

Sass reference (static/sassdoc)

The Sass API docs under static/sassdoc are committed to the repo. Regenerate locally only when SCSS changes require it (install sassdoc temporarily, run sassdoc lbh --dest static/sassdoc, then commit).

About

Everything you need to build user interfaces for Hackney platforms and services.

Topics

Resources

Stars

9 stars

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages