Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.03 KB

README.md

File metadata and controls

73 lines (52 loc) · 2.03 KB
Raw

@atoms-studio/nuxt-redirects

npm version npm downloads License Nuxt

A Nuxt module that allows for redirect management using a simple CSV file, it leverages zod-csv under the hood for validation, handling both punctual and regex redirects. An example CSV file can be found here.

Quick Setup

  1. Add the @atoms-studio/nuxt-redirects dependency to your project.
# Using pnpm
pnpm add -D @atoms-studio/nuxt-redirects

# Using yarn
yarn add --dev @atoms-studio/nuxt-redirects

# Using npm
npm install --save-dev @atoms-studio/nuxt-redirects
  1. Add @atoms-studio/nuxt-redirects to the modules section of your nuxt.config.ts file.
export default defineNuxtConfig({
  modules: ["@atoms-studio/nuxt-redirects"],
});

That's it! You can now start using it 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

License

Licensed under the MIT License.