Installation

Quick Install

To add Nuxt Calendar to your project, run the following command in your terminal:

npx nuxi module add @shiftesc/nuxt-calendar

Manual Installation

If you prefer to install the package manually, use your favorite package manager:

pnpm add @shiftesc/nuxt-calendar

npm install @shiftesc/nuxt-calendar

yarn add @shiftesc/nuxt-calendar

Add to Nuxt Config

After installing, add @shiftesc/nuxt-calendar to the modules section of your nuxt.config.ts:

export default defineNuxtConfig({
  modules: [
    '@shiftesc/nuxt-calendar'
  ]
})

Requirements

• Nuxt: ^3.0.0 or ^4.0.0
• Nuxt UI: Recommended for the best experience, but not strictly required for logic-only features.
• Node.js: ^18.0.0 or higher.

Pro Version

While the core features of Nuxt Calendar are free to use, advanced features like Database Sync, Teams, and ICS Integration require a Pro license.

You can get your license key at nuxtcalendar.com.

Next Steps

Once installed, you can start using the <NuxtCalendar /> component or any of the provided composables. Check out the Quick Start guide to see it in action.