@economist/design-system

The Economist Design System

Overview

This is the repository for the Economist Design System. https://www.economistdesignsystem.com

Directory Structure

• src - The components for the Design System (JavaScript and CSS modules)
• examples - Examples of how to reference the Design System in a project
• www - The website for economistdesignsystem.com

## Building

Run npm run build to run all the build steps.

This will run steps to compile JavaScript and CSS and output importable modules to ./dist.

Examples

To see how to use the Design System components in your own projects, checkout the examples in ./examples/.

e.g.

cd examples/next-js
npm install
npm run dev

Deploying

There are build and deploy command defined in in package.json but deployment and release is not yet automated (you must have AWS credentials appropriately configured for the deploy command to work).

Publishing to NPM

Automated module publishing is not yet configured, currently you must have access to the @economist org on NPM to publish modules.

To publish a canary (preview) release, update the 'version' in package.json to add the suffix -canary. followed by a version number (e.g. so it looks like "version": "0.0.1-canary.0") and run NPM with the --tag option:

npm publish --tag canary

To publish a 'production' release, just run NPM publish:

npm publish