Getting started with Product NameLast updated March 30, 2026
Help me get set up with Product Name. Based on my project, do the following: 1. Install @astryxdesign/core and import its precompiled reset.css and astryx.css once at the app entry point. 2. Wrap my app in Theme with a theme package such as @astryxdesign/theme-neutral. 3. Replace one existing component with an Astryx equivalent. Prerequisites
- Node.js 18+
- React 19 or later
- A package manager (npm, yarn, or pnpm)
Install the package
Every project starts with installing the core package. This gives you access to all components, tokens, and utilities.Step 1: Install the core packagenpm install @astryxdesign/core
Step 2: Import the precompiled stylesAstryx ships precompiled CSS, so there is no build plugin to configure. Import the reset and component stylesheets once at your app entry point.import '@astryxdesign/core/reset.css';
import '@astryxdesign/core/astryx.css';
Step 3: Import your first componentimport { Button } from '@astryxdesign/core/Button';
export default function App() {
return <Button label="Hello Astryx" variant="primary" />;
}
Astryx ships with a default theme that works out of the box. To customize colors, typography, and spacing, install a theme package, import its stylesheet, and wrap your app in Theme.import { Theme } from '@astryxdesign/core/theme';
import { neutralTheme } from '@astryxdesign/theme-neutral/built';
import '@astryxdesign/theme-neutral/theme.css';
export default function App({ children }) {
return <Theme theme={neutralTheme}>{children}</Theme>;
}
See the theming guide for the full list of customizable tokens. Next steps
- Fundamental concepts — How theming, layout, and composition work
- Component API reference — Props, variants, and examples for every component
- Accessibility — Built-in a11y features and ARIA patterns
- CLI tools — Scaffold projects and manage templates
- Design tokens — Colors, spacing, typography, and sizing