Skip to content

Latest commit

 

History

History
94 lines (64 loc) · 2.43 KB

README.md

File metadata and controls

94 lines (64 loc) · 2.43 KB
Raw

NuxtHub

npm version npm downloads License Nuxt

Build full-stack applications with Nuxt on Cloudflare, with zero configuration.

Features

  • SQL database to store your application's data with hubDatabase()
  • Key-Value to store JSON data accessible globally with low-latency with hubKV()
  • Blob storage to store static assets, such as images, videos and more with hubBlob()
  • Cache storage to cache your server route responses or functions using Nitro's cachedEventHandler and cachedFunction

Read more on https://hub.nuxt.com

Quick Setup

Duplicate our nuxt-hub/starter or create a new NuxtHub project with:

npx nuxthub init my-app

Add to a Nuxt project

  1. Install @nuxthub/core dependency to your project:
npx nypm@latest add @nuxthub/core
  1. Install wrangler development dependency to your project:
npx nypm@latest add -D wrangler
  1. Add @nuxthub/core to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    '@nuxthub/core'
  ]
})

That's it! You can now use NuxtHub features in your Nuxt app ✨

Contributing

# Install dependencies
pnpm i

# Generate type stubs
pnpm dev:prepare

# Develop with the playground
pnpm dev

# Build the playground
pnpm dev:build

# Run ESLint
pnpm lint

# Run Vitest
pnpm test
pnpm test:watch

# Release new version
pnpm release

License

Apache 2.0