Skip to content

Installation

Automatic Install

To install and register the latest version of Frogger run the following command:

sh
$ pnpm dlx nuxi@latest module add nuxt-frogger
sh
$ npx nuxi@latest module add nuxt-frogger
sh
$ yarn dlx nuxi@latest module add nuxt-frogger
sh
$ bunx nuxi@latest module add nuxt-frogger

A default configuration of Frogger is now installed in your Nuxt project. Take a look at the Getting Started guide to learn how to make your first log.

Want to make some changes to Frogger's configuration? Check out the Configuration guide.

Manual Install

Does command above not work? To install Frogger and register it manually:

sh
$ pnpm add nuxt-frogger
sh
$ npm install nuxt-frogger
sh
$ yarn add nuxt-frogger
sh
$ bun add nuxt-frogger

Register the Module

Add 'nuxt-frogger' as a module in your nuxt.config.ts file.

ts
export default defineNuxtConfig({
    modules: [
        'nuxt-frogger'
    ]
})

While everything should work out of the box, I recommend at least setting up a name and version for your application that will be included in the logs. Set the app property in the frogger configuration object in your nuxt.config.ts file:

ts
export default defineNuxtConfig({
    modules: [
        'nuxt-frogger'
    ],

    frogger: {
        app: {  
            name: 'My App',  
            version: '1.0.0'
        } 
    } 
})

For more configuration options, check out the Configuration guide.