Skip to content

atoms-studio/nuxt-swiftsearch

Repository files navigation

Nuxt Swiftsearch

npm version npm downloads License Nuxt

A tailor made implementation of algolia instantsearch for nuxt 3.

Features

  • 🍀  SSR First, client only on demand, as is any other nuxt component
  • 🗼  Centralized state, you can tap into it from anywhere in your app
  • 🌲  99% compatible with vue-instantsearch current implementation
  • 👮  Typed components

Quick Setup

  1. Add @atoms-studio/nuxt-swiftsearch dependency to your project
npx nuxi@latest module add swiftsearch
  1. Add @atoms-studio/nuxt-swiftsearch to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: ["@atoms-studio/nuxt-swiftsearch"],
});

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

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release

About

A tailor made implementation of algolia instantsearch for nuxt 3

Resources

License

Stars

Watchers

Forks

Packages

No packages published