Getting Started
Configuration
Configure Zinka to work with your specific requirements
Updated January 15, 2024
1 min read
Configuration
Configure Zinka to work perfectly with your project requirements.
Basic Configuration
Create a zinka.config.js file in your project root:
export default {
apiKey: process.env.ZINKA_API_KEY,
environment: process.env.NODE_ENV || 'development',
features: {
analytics: true,
notifications: true,
realTimeSync: false
}
};
Environment Variables
Set up the following environment variables:
ZINKA_API_KEY=your_api_key_here
ZINKA_ENVIRONMENT=production
Advanced Configuration
For more advanced setups, you can customize various aspects:
Custom Endpoints
export default {
endpoints: {
api: 'https://api.zinka.com',
websocket: 'wss://ws.zinka.com'
}
};
Feature Flags
export default {
features: {
analytics: {
enabled: true,
trackPageViews: true,
trackUserActions: false
}
}
};
Validation
Zinka automatically validates your configuration on startup. If there are any issues, you'll see detailed error messages in the console.