Installation · NuxtHub

Quickstart

The easiest way to get started with NuxtHub is to start with one of our templates. It includes all the necessary configuration and resources to get you started.

Click on the GitHub button, then once on GitHub, click on Use this template to create a new repository based on the template.

Explore NuxtHub templates.

Add to a Nuxt project

Install the NuxtHub module to your project:

Terminal

npx nuxi module add @nuxthub/core-nightly

This command will install @nuxthub/core as dependency and add it to your modules section of your nuxt.config.

That's it! You can now use NuxtHub features in your Nuxt project.

NuxtHub will create a .data directory in your project root, which contains the necessary configuration files and resources for the features to work. It will also add it to the .gitignore file to avoid committing it to your repository.

Options

Configure options in your nuxt.config.ts as such:

nuxt.config.ts

export default defineNuxtConfig({
  modules: ['@nuxthub/core'],
  hub: {
    // NuxtHub options
  }
})

blob

boolean

Default to false - Enables blob storage to store static assets, such as images, videos and more.

cache

boolean

Default to false - Enables cache storage to cache your server route responses or functions using Nitro's cachedEventHandler and cachedFunction

database

'postgresql' | 'sqlite' | 'mysql'

Default to false - Enables SQL database to store your application's data.

boolean

Default to false - Enables Key-Value to store JSON data.

You're all set! Now, let's dive into deploying it.