vite-plugin-local

A smart Vite plugin that enables pretty development URLs, including HTTPS.

Features

• Proxies HTTP/HTTPS requests
• Pretty development URLs
• Smart HTTPS management
• Automatically cleans URLs
• Lightweight
• Soon: Local Tunneling & WebSocket Proxying

Install

npm install -d vite-plugin-local
# bun install -d vite-plugin-local

Get Started

// vite.config.ts
import { defineConfig } from 'vite'
import Local from 'vite-plugin-local'

export default defineConfig({
  plugins: [
    Local({
      domain: 'my-app.local', // default: stacks.localhost
      https: true, // default: true, pass TlsConfig options for custom certificates
      cleanup: {
        certs: true, // default: false, cleans up the certificates created on server shutdown
        hosts: true, // default: true, cleans up /etc/hosts on server shutdown
      },
      cleanUrls: true, // default: false, cleans up URLs by not requiring the .html extension
      verbose: true, // default: false, enables detailed logging
    })
  ]
})

To learn more, head over to the documentation.

Testing

bun test

Changelog

Please see our releases page for more information on what has changed recently.

Contributing

Please review the Contributing Guide for details.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

Postcardware

“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where vite-plugin-local is being used! We showcase them on our website too.

Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎

Sponsors

We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.

• JetBrains
• The Solana Foundation

Credits

• Chris Breuer
• All Contributors

License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙