Getting Started

Installation

Get started with nuxt-reviews in your Nuxt project.

Quick Setup

Terminal
npx nuxi module add nuxt-reviews

Or install manually:

pnpm add nuxt-reviews

Add to Nuxt Config

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-reviews'],

  reviews: {
    providers: {
      google: {
        apiKey: process.env.GOOGLE_API_KEY,
        placeId: process.env.GOOGLE_PLACE_ID
      }
    }
  }
})

That's it! The module automatically registers server API routes and the useReviews() composable.

Environment Variables

Keep API keys out of source code:

.env
GOOGLE_API_KEY=AIzaSy...
GOOGLE_PLACE_ID=ChIJ...