From 39f8a4aff2573af54ed93cb267b7e72c5fbacfbf Mon Sep 17 00:00:00 2001 From: Philippe Serhal Date: Sat, 7 Feb 2026 12:13:27 -0500 Subject: [PATCH] docs(wip): add npmx deployment instructions --- DEPLOY.md | 26 ++++++++++++++++++++++++++ README.md | 6 ++++++ 2 files changed, 32 insertions(+) create mode 100644 DEPLOY.md diff --git a/DEPLOY.md b/DEPLOY.md new file mode 100644 index 000000000..36881cb33 --- /dev/null +++ b/DEPLOY.md @@ -0,0 +1,26 @@ +# Deploy your own npmx + +The npmx community operates a public instance at [npmx.dev](https://npmx.dev), but is designed to be open and self-hostable by anyone [on any platform that supports Nuxt](https://nuxt.com/deploy). + +To deploy your own instance, follow the steps below for your deployment target. + +> [!TIP] +> This page is under construction. More deployment targets are coming soon. + + + +## Netlify + +1. [Follow the Netlify instructions to import an existing GitHub project](https://docs.netlify.com/start/quickstarts/deploy-from-repository/), selecting https://github.com/npmx-dev/npmx.dev/ when prompted. +2. Generate a long, random key and set it as an environment variable in your new project called `SESSION_PASSWORD`. +3. TODO something something Upstash creds? +4. Run `pnpm remove @vercel/kv && pnpm add @netlify/blobs` +5. Commit and push this change. This will trigger a successful deploy. +6. TODO anything else? + +## Vercel + +1. [Follow the Vercel instructions to import an existing GitHub project](https://vercel.com/docs/getting-started-with-vercel/import), selecting https://github.com/npmx-dev/npmx.dev/ when prompted. +2. Generate a long, random key and set it as an environment variable in your new project called `SESSION_PASSWORD`. +3. TODO something something Upstash creds? +4. TODO anything else? diff --git a/README.md b/README.md index 0e079fbe8..f89ad0c46 100644 --- a/README.md +++ b/README.md @@ -144,6 +144,12 @@ npmx.dev also supports shorter, cleaner URLs: - [nuxt-og-image](https://github.com/nuxt-modules/og-image) - [npm Registry API](https://github.com/npm/registry/blob/main/docs/REGISTRY-API.md) +## Deploy your own npmx instance + +The npmx community operates a public instance at [npmx.dev](https://npmx.dev), but is designed to be open and self-hostable by anyone [on any platform that supports Nuxt](https://nuxt.com/deploy). + +To deploy your own instance, follow the instructions in [DEPLOY.md](./DEPLOY.md). + ## Contributing We welcome contributions – please do feel free to explore the project and improve things. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get up and running!