Axiom

Axiom is the technical implementation of the Optimizely Design System.

Getting Started

npm install @optiaxiom/react

import { Text } from "@optiaxiom/react";

function App() {
  return <Text>Hello World!</Text>;
}

Please read the full documentation for guides, examples, and API.

Contributing

Clone the project and run:

pnpm install

Development

Run the following to start your dev environment:

pnpm dev

This will spin up all the apps and packages in dev mode. Use pnpm filtering to run individual apps:

# run docs only (along with all dependencies)
pnpm -F docs... --parallel dev

# run storybook only (along with all dependencies)
pnpm -F storybook... --parallel dev

Testing

Run lint and test to run the linter and unit tests respectively:

pnpm lint

# run tests (in watch mode)
pnpm test
# run tests (once and exit)
pnpm test run

Building

Run build to build the whole project or individual packages:

pnpm build

# build react only
pnpm -F react build