@forensic-architecture/design-system

Forensic Architecture's component library


Keywords
visualization
License
BSD-3-Clause-No-Nuclear-License
Install
npm install @forensic-architecture/design-system@0.4.0

Documentation

Scripts

  • npm run start:app: Starts the Create React App application, which enables local testing of our NPM-published component library.
  • npm run start:storybook: Runs an instance of Storybook, for easier component-driven development.
  • npm run test: Runs component tests using Enzyme and Jest.
  • npm run build:react:lib: Builds our React component library using Rollup (anything inside src/lib/ into the dist folder)
  • npm run build:react:storybook: Generates static files and a storybook-static folder for external consumption of our design system. This will be continuously deployed through Netlify at design.forensic-architecture.org

Library building and testing with Rollup

Run npm run build:react:lib from the root folder — this will generate a dist/ folder, along with styles. Then, run:

cd dist/
npm link

Initial publication to NPM

Publish under our @forensic-architecture organization. npm publish --access public.

Developing timemap via design-system

Or any other external repo locally:

npm run build:react:watch
# in the timemap repo
npm link @forensic-architecture/design-system

Components from design-system can then be imported like so: import {Button} from '@forensic-architecture/design-system'. Provided the build system of the external repo watches 'node_modules' for changes, the code should auto-refresh on changes in design-system as it normally would for changes within the timemap repo.