Skip to main content

Installation

luxy packages publish under the @luxy-creative scope. They currently publish privately to GitHub Packages from luxy-creative/luxy.

Private registry access

Apps outside the luxy monorepo need project-level registry config and a token with read:packages.

@luxy-creative:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

Keep the token in your local environment or CI secrets, not in source control.

Brand primitives

pnpm add @luxy-creative/brand

@luxy-creative/brand is the canonical source for luxy brand metadata, colors, serializable brand tokens, and logo asset metadata. It has no native rendering peers.

Core only

pnpm add @luxy-creative/core

Use @luxy-creative/core for outcome, haptic, theme, accessibility, reduced motion, and quality-tier contracts.

Scratch card

pnpm add @luxy-creative/core @luxy-creative/scratch-card
pnpm exec expo install @shopify/react-native-skia react-native-gesture-handler react-native-reanimated expo-haptics expo-image

Required peers:

  • React >=19
  • React Native >=0.85
  • @shopify/react-native-skia
  • react-native-gesture-handler
  • react-native-reanimated
  • expo-haptics
  • expo-image

Slot machine

pnpm add @luxy-creative/core @luxy-creative/slot-machine
pnpm exec expo install @shopify/react-native-skia react-native-reanimated expo-haptics

Required peers:

  • React >=19
  • React Native >=0.85
  • @shopify/react-native-skia
  • react-native-reanimated
  • expo-haptics

Gesture Handler is not required for the v1 slot-machine package.

Expo setup notes

  • Use expo install for native peers so the installed versions match your Expo SDK.
  • Reanimated must be configured according to the host app's Expo SDK instructions.
  • Use Expo Go first when the app only uses Expo Go-compatible native modules.
  • Use a development client or release build when your app has custom native code or when profiling native performance.
  • Native release builds are required before production launch decisions.