hpe design-system monorepo

HPE Design System Site

- https://design-system.hpe.design/

Storybook

- http://storybook.hpe.design/

Welcome to HPE Design System

Aries is a monorepo built from two modules.

1. aries-core
2. aries-site (For designers and developers. This is the documentation site for the HPE Design System.)

The Monorepo is installed using yarn, and relies on yarn workspaces.

Packages are automatically linked together, meaning you can do cross-package work within the repo. woot-woot!

Basic structure and configurations

aries/
  aries-*/
    src/js/
      index.js
    package.json         // package-specific deps and scripts
    README.md            // shown in npmjs.com. included in npm artifact

.eslintignore            // eslint (linter) ignored directories/files
.eslintrc                // eslint (linter) configuration based on @hpe/project-scripts
.gitignore               // github's default node gitignore with customizations
.prettierrc.js           // prettier (formatter) configuration based on @hpe/project-scripts
package.json             // common dev deps and workspace-wide scripts WIP
README.md                // workspace-wide information. shown in github
yarn.lock                // the only lock file in the repo. all packages combined

Getting Started

yarn install

Running 'yarn install' anywhere in the monorepo hierarchy will always install ALL the modules in the workspaces.

Note: When installing, you may get and error saying "Integrity check failed for 'grommet' (computed integrity doesn't match our records...". aries-site references the latest stable branch of grommet. Any new commits added to grommet's stable branch cause its SHA hash to be updated and become out of sync with the SHA in the yarn.lock file.

To fetch the latest grommet stable, remove yarn.lock and clean yarn cache, then yarn install. For example: rm yarn.lock && yarn cache clean && yarn install

Run aries-site in development mode:

cd aries-site
yarn start

Running in production mode:

yarn build