You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,6 +92,17 @@ tests/ # Playwright E2E tests
92
92
> [!TIP]
93
93
> For more about the meaning of these directories, check out the docs on the [Nuxt directory structure](https://nuxt.com/docs/4.x/directory-structure).
94
94
95
+
### Local connector CLI
96
+
97
+
The `cli/` workspace contains a local connector that enables authenticated npm operations from the web UI. It runs on your machine and uses your existing npm credentials.
98
+
99
+
```bash
100
+
# run the connector from the root of the repository
101
+
pnpm npmx-connector
102
+
```
103
+
104
+
The connector will check your npm authentication, generate a connection token, and listen for requests from npmx.dev.
Copy file name to clipboardExpand all lines: README.md
+94-72Lines changed: 94 additions & 72 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,33 +12,98 @@
12
12
13
13
## Vision
14
14
15
-
The aim of [npmx.dev](https://npmx.dev) is to provide a better browser for the npm registry - fast, accessible, and designed for power users.
15
+
The aim of [npmx.dev](https://npmx.dev) is to provide a better browser for the npm registry – fast, accessible, and designed for power users. We don't aim to replace the [npmjs.com](https://www.npmjs.com/) registry, just provide a better UI and DX.
16
16
17
-
-**Speed first**- Insanely fast searching, filtering, and navigation.
18
-
-**URL compatible**- Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works.
19
-
-**Provenance aware**- See at a glance which packages have verified build provenance.
17
+
-**Speed first**– Layout shift, flakiness, slowness is The Worst. Fast searching, filtering, and navigation.
18
+
-**URL compatible**– Replace `npmjs.com` with `xnpmjs.com` or `npmx.dev` in any URL and it just works.
19
+
-**Simplicity**– No noise, cluttered display, or confusing UI. If in doubt: choose simplicity.
20
20
21
21
## Features
22
22
23
-
-**Dark mode by default** - easier on the eyes
24
-
-**Package browsing** - fast search, package details, READMEs, versions, dependencies
25
-
-**User profiles** - view any npm user's public packages at `/~username`
26
-
-**Organization pages** - browse org packages at `/org/orgname`
27
-
-**Provenance indicators** - verified build indicators for packages with npm provenance
28
-
-**Admin features** - org/team management, package access controls via local connector (coming soon)
I'd welcome contributions – please do feel free to poke around and improve things. Here's how you can get going locally.
54
-
55
-
### Setup
56
-
57
-
```bash
58
-
# install dependencies
59
-
corepack enable
60
-
pnpm install
61
-
62
-
# serve in dev mode, with hot reload at localhost:3000
63
-
pnpm dev
64
-
65
-
# build for production
66
-
pnpm build
67
-
68
-
# preview in production mode
69
-
pnpm preview
70
-
```
71
-
72
-
### Testing
73
-
74
-
```bash
75
-
# run all tests
76
-
pnpm test
77
-
78
-
# run unit tests
79
-
pnpm test:unit
80
-
81
-
# run e2e tests
82
-
pnpm test:browser
83
-
84
-
# type check
85
-
pnpm test:types
86
-
```
87
-
88
-
### Local connector (CLI)
89
-
90
-
The `cli/` workspace contains a local connector that enables authenticated npm operations from the web UI. It runs on your machine and uses your existing npm credentials.
91
-
92
-
```bash
93
-
# run the connector from the root of the repository
94
-
pnpm npmx-connector
95
-
```
116
+
## Contributing
96
117
97
-
The connector will check your npm authentication, generate a connection token, and listen for requests from npmx.dev.
118
+
I'd welcome contributions – please do feel free to poke around and improve things. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get up and running!
98
119
99
120
## Related projects
100
121
101
-
-[JSR](https://jsr.io/) - The open-source package registry for modern JavaScript and TypeScript
102
-
-[npm-userscript](https://github.com/bluwy/npm-userscript) - Browser userscript with various improvements and fixes for npmjs.com
103
-
-[npm-alt](https://npm.willow.sh/) - An alternative npm package browser
122
+
-[npmx-replace-extension](https://github.com/tylersayshi/npmx-replace-extension)– Browser extension to redirect npmjs.com to npmx.dev
123
+
-[JSR](https://jsr.io/)– The open-source package registry for modern JavaScript and TypeScript
124
+
-[npm-userscript](https://github.com/bluwy/npm-userscript)– Browser userscript with various improvements and fixes for npmjs.com
125
+
-[npm-alt](https://npm.willow.sh/)– An alternative npm package browser
0 commit comments