Skip to content

Commit 39f8a4a

Browse files
committed
docs(wip): add npmx deployment instructions
1 parent a81dbe0 commit 39f8a4a

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

DEPLOY.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Deploy your own npmx
2+
3+
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).
4+
5+
To deploy your own instance, follow the steps below for your deployment target.
6+
7+
> [!TIP]
8+
> This page is under construction. More deployment targets are coming soon.
9+
10+
<!-- NOTE: Please list targets alphabetically to remain neutral. -->
11+
12+
## Netlify
13+
14+
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.
15+
2. Generate a long, random key and set it as an environment variable in your new project called `SESSION_PASSWORD`.
16+
3. TODO something something Upstash creds?
17+
4. Run `pnpm remove @vercel/kv && pnpm add @netlify/blobs`
18+
5. Commit and push this change. This will trigger a successful deploy.
19+
6. TODO anything else?
20+
21+
## Vercel
22+
23+
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.
24+
2. Generate a long, random key and set it as an environment variable in your new project called `SESSION_PASSWORD`.
25+
3. TODO something something Upstash creds?
26+
4. TODO anything else?

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,12 @@ npmx.dev also supports shorter, cleaner URLs:
144144
- [nuxt-og-image](https://github.com/nuxt-modules/og-image)
145145
- [npm Registry API](https://github.com/npm/registry/blob/main/docs/REGISTRY-API.md)
146146

147+
## Deploy your own npmx instance
148+
149+
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).
150+
151+
To deploy your own instance, follow the instructions in [DEPLOY.md](./DEPLOY.md).
152+
147153
## Contributing
148154

149155
We welcome contributions &ndash; 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!

0 commit comments

Comments
 (0)