Installation
Prerequisites
- Node.js 18 or higher
- Expo SDK 54 or higher (for Expo projects)
- React Native 0.74 or higher
Install from GitHub Packages
This package is published on GitHub Packages. You'll need to configure npm to authenticate with GitHub.
1. Create a Personal Access Token (PAT)
- Go to GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)
- Generate a new token with
read:packagesscope - Copy the token
2. Configure .npmrc
Create or update .npmrc in your project root:
@multinaire:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${AUTH_TOKEN}
Set the environment variable with your token:
# Add to your shell profile (.bashrc, .zshrc, etc.)
export AUTH_TOKEN=your_github_pat_here
Or for CI/CD, set AUTH_TOKEN as a secret environment variable.
3. Install the Package
npm install @multinaire/multinaire-design
Or with yarn:
yarn add @multinaire/multinaire-design
Peer Dependencies
The library has several peer dependencies. Most are already included in a standard Expo project:
# Core dependencies (usually already installed)
npm install expo expo-font expo-image react-native-reanimated react-native-svg
# Navigation (if using navigation components)
npm install expo-router @react-navigation/native react-native-screens react-native-safe-area-context
# Storage (for persisting theme/language preferences)
npm install @react-native-async-storage/async-storage
# i18n (for localization)
npm install i18next react-i18next
# Date picker (if using DateTimePicker)
npm install react-native-ui-datepicker
Verify Installation
Create a simple test to verify the installation:
import { MultinaireText } from '@multinaire/multinaire-design';
export default function App() {
return <MultinaireText>Installation successful!</MultinaireText>;
}
If you see the text rendered, the installation is complete.
Next Steps
- Configuration - Set up the provider
- Theme Setup - Configure your theme