Documentation

Full documentation is available at:

• formforge.schleret.ch

Use this README as a quick start only.

Requirements

• Nuxt 4.x
• @nuxt/ui 4.x
• Node.js >=20 or Bun >=1.3

Install

bun add @evanschleret/formforgeclient

Minimal setup

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/ui', '@evanschleret/formforgeclient'],
  formforgeClient: {
    baseURL: '/api/formforge/v1',
    credentials: 'include'
  }
})

Minimal renderer usage

<script setup lang="ts">
const route = useRoute()
</script>

<template>
  <FormForgeRenderer :form-key="String(route.params.form)" />
</template>

Scoped routes quick example

// nuxt.config.ts
export default defineNuxtConfig({
  formforgeClient: {
    baseURL: '/api/formforge/v1',
    scopedRoutes: {
      team: {
        prefix: 'teams/{team}',
        paramsFromRoute: {
          team: 'team'
        }
      }
    },
    defaultScope: 'team'
  }
})

const management = useFormForgeManagement()

const forms = await management.listForms(false)

Useful links

• Backend package: evanschleret/formforge
• Security policy: SECURITY.md
• Contributing: CONTRIBUTING.md
• License: LICENSE