Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.57 KB

File metadata and controls

33 lines (21 loc) · 1.57 KB

Code structure

At a high level, the Pharos code base consists of two packages, @ithaka/pharos and @ithaka/pharos-site, along with supporting continuous integration infrastructure code.

Infrastructure code

The infrastructure code enables continuous integration tools to perform activities like unit testing, visual regression testing, deployment of Storybooks, and so on. You can find infrastructure related code in the jenkins/ and k8s/ directories.

@ithaka/pharos package

The @ithaka/pharos package contains the design tokens and components you can use to develop user interfaces for your pages. The package contains a number of additional directories:

packages/pharos
├── ...
├── scripts/
├── src/
└── tokens/

The scripts/ directory contains code for building the package. The src/ directory contains the TypeScript code for all Pharos components, along with utilities for developing those components. The tokens/ directory contains the design tokens used to define Pharos' visual language.

@ithaka/pharos-site package

The @ithaka/pharos-site package contains a Gatsby-based site that will act as a portal for Pharos consumers to read the Pharos design guidelines, download brand assets, and so on. The site is in active design and development but not yet ready for mass consumption.