Getting Started
Introduction
Nuxt UseSuperflow is a module that integrates UseSuperflow with your Nuxt.js application. This module provides a seamless way to add UseSuperflow's functionality to your Nuxt project.
Installation
- Install the module using your preferred package manager:
bash
npm install nuxt-usesuperflow
bash
yarn add nuxt-usesuperflow
bash
pnpm add nuxt-usesuperflow
bash
bun add nuxt-usesuperflow
- Add the module to your
nuxt.config.ts
:
ts
export default defineNuxtConfig({
modules: ['nuxt-usesuperflow'],
usesuperflow: {
projectId: 'your-project-id', // Required
apiKey: 'your-api-key' // Required
}
})
Alternatively, you can use environment variables:
env
USESUPERFLOW_PROJECT_ID=your-project-id
USESUPERFLOW_API_KEY=your-api-key
Requirements
- Nuxt.js version 3.0 or higher
- Node.js version as specified in your package.json engines field
Basic Usage
After installation, you can use the module in your Nuxt application:
vue
<script setup>
const { superflow } = useSuperflow()
// Your UseSuperflow logic here
</script>
<template>
<div>
<!-- Your UseSuperflow components here -->
</div>
</template>
Configuration
The module can be configured through the usesuperflow
property in your nuxt.config.ts
. See the configuration reference for all available options.
Next Steps
- Check out the Configuration section for detailed setup options
- View the API Reference for technical details
- Visit our GitHub repository for source code and contributions