A stateless proxy server to the npm registry that serves fancied up package metadata.
This is what the server does when you fetch a package:
First, the raw package metadata is fetched from registry.npmjs.com. This is
the only network request made per package.
The dependent-packages module adds dependency info for the package, without making a network request:
directDependentsdirectDependentsCountdirectDevDependentsdirectDevDependentsCounttotalDirectDependentsCount
The download-counts adds a averageDownloadsPerDay property to the package.
This is also added without making a network request/
The owners and owner-profiles packages are used to create an owners array
which includes the following metadata for each npm user, as available:
name- full nameemail- public email addresshomepage- a URLgithub- GitHub handletwitter- Twitter handlegravatar- HTTPS gravatar urlpackageCount- how many packages thes user owns
No network requests are made here either.
Lastly, the resulting package object is turned into a [nice package], which has these qualities:
- uses
normalize-package-dataas a baseline for cleanup, then: - uses the
doc['dist-tags'].latestas the baseline for package metadata - derives
starsCountfrom theusersobject - derives a
versionsarray from thetimeobject - renames
_npmUsertolastPublisher, because it's a more intuitive name. - renames
maintainerstoowners, for consistency with the npm's CLI commands. - normalizes GitHub repository URLs to
httpsformat - moves internal bookkeeping properties like
_idand_frominto anotherobject that can easily be omitted.
The following routes are supported:
Fetches a single package. The following query params are allowed:
Examples:
Fetches multiple packages by name. The following query params are allowed:
names(required) - a comma-delimited string of package names to fetchpick- a comma-delimited string of properties to include in the response.omit- a comma-delimited string of properties to omit from the response.
Examples:
- /packages?names=human-interval,supertest
- [/packages/?names=react,react-dom, redux&pick=name,description](https://nice-registry.herokuapp.com/packages/?names=react,react-dom, redux&pick=name,description)
There's a public instance running on Heroku.
Example URL: http://nice-registry.herokuapp.com/package/cheerio?omit=readme,versions,other,directDependents,
This server's design follows the 12 Factor development methodology popularized by Heroku. It is stateless: that is, it does not include a database, nor does it write to the filesystem.
Each package request makes just one network call, and that is to fetch the main package data from the npm registry. Supplementary data for download counts, dependents, owner profiles, etc, is provided by offline datasets that are automatically updated and published to npm by bots.
This server can optional cache responses in Redis. If you specify a REDIS_URL
in the environment, then it will be used. If you don't, it won't. No
configuration required.
Setting up your own instance on Heroku only requires a few commands:
git clone https://github.com/nice-registry/nice-registry
cd nice-registry
heroku create my-nice-registry
heroku addons:add heroku-redis
git push heroku masternpm install
npm testMIT
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent