Vercel SPA

A simple CLI tool to generate a vercel.json file configured for Single Page Application (SPA) routing on Vercel.

Installation

Install the package globally to use it from the command line:

npm install -g vercel-spa

Or, run it directly using npx:

npx vercel-spa

Usage

Navigate to your project directory and run:

vercel-spa

This will create a vercel.json file in your project root with the following content:

{
  "rewrites": [
    {
      "source": "/(.*)",
      "destination": "/index.html"
    }
  ]
}

This configuration ensures that all routes are redirected to index.html, allowing client-side routing (e.g., React Router) to handle navigation without 404 errors on refresh.

Notes

• If a vercel.json file already exists, the command will exit with an error to prevent overwriting. Delete or modify the existing file manually if needed.
• This package uses the fs-extra library for reliable file operations.

License

MIT