Getting Started

Installation

Get started with Nuxt UI Pro documentation template.
Use this module in your Nuxt project to auto inject the Creem API and server utilities.

Quick Start

You can start a fresh new project with:

Terminal
npx nuxi init -t project_name

or create a new repository from GitHub:

  1. Open https://github.com/nuxt-ui-pro/docs
  2. Click on Use this template button
  3. Enter repository name and click on Create repository from template button
  4. Clone your new repository
  5. Install dependencies with your favorite package manager
  6. Start development server

That's it! You can now start writing your documentation in the content/ directory 🚀

Minimum Configuration

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxtjs/creem'],
  devtools: { enabled: true },
  runtimeConfig: {
    creem: {
      environment: process.env.NUXT_CREEM_ENVIRONMENT,
      returnUrl: process.env.NUXT_CREEM_RETURN_URL,
      webhookSecret: process.env.NUXT_CREEM_WEBHOOK_SECRET,
      tokens: {
        test: process.env.NUXT_CREEM_TEST_TOKEN,
        live: process.env.NUXT_CREEM_LIVE_TOKEN,
      },
    },
    public: {
      siteUrl: process.env.NUXT_CREEM_SITE_URL,
    },
  },
  future: {
    compatibilityVersion: 4,
  },
  compatibilityDate: '2025-02-11',
})
.env.example
NUXT_SITE_URL=https://example.com
NUXT_CREEM_RETURN_URL=https://example.com/return
NUXT_CREEM_ENVIRONMENT=test
NUXT_CREEM_TEST_TOKEN=creem_test_...
NUXT_CREEM_LIVE_TOKEN=creem_live_...
NUXT_CREEM_WEBHOOK_SECRET=secret