https://github.com/nodesource/npmsearch

blazing fast npm search utility
https://github.com/nodesource/npmsearch

nodejs npm npmsearch

Last synced: 26 days ago
JSON representation

blazing fast npm search utility

• Host: GitHub
• URL: https://github.com/nodesource/npmsearch
• Owner: nodesource
• License: mit
• Created: 2014-01-02T02:59:14.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2017-04-17T13:31:29.000Z (over 7 years ago)
• Last Synced: 2024-11-01T19:36:17.057Z (about 1 month ago)
• Topics: nodejs, npm, npmsearch
• Language: JavaScript
• Homepage: http://npmsearch.com
• Size: 794 KB
• Stars: 274
• Watchers: 10
• Forks: 34
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-blazingly-fast - npmsearch - blazing fast npm search utility (JavaScript)

README

        
# npmsearch.com

[![N|Solid](https://cldup.com/dTxpPi9lDf.thumb.png)](https://nodesource.com/products/nsolid)

This is the code that powers [npmsearch.com](http://npmsearch.com), which provides a clean interface to searching pseudo-rated node packages from npm.

## api

To query the npmsearch index, you can use the HTTP api which is effectively a proxy to elasticsearch's [URI Search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html).

All requests go through http://npmsearch.com/query. Here's an example:

```

curl "http://npmsearch.com/query?q=dom&fields=name"

{"results":[{"name":["select-dom"]},{"name":["dom-manipulations"]},{"name":["zero-dom"]},{"name":["dom-stub"]},{"name":["dom-walk"]},{"name":["dom-value"]},{"name":["karma-chai-dom"]},{"name":["dom-select"]},{"name":["dom-listeners"]},{"name":["has-dom"]}],"total":7265,"from":0}

```

### Available fields

* __author__

* __created__

* __dependencies__

* __description__

* __devDependencies__

* __homepage__

* __keywords__

* __maintainers__

* __modified__

* __name__

* __readme__

* __repository__

* __scripts__

* __times__

* __version__

* __rating__ - computed rating as per [bin/rating.js](bin/rating.js)

# Running your own npmsearch

## Setup Elasticsearch

See the [elasticsearch docs](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html) for setting up a node

```bash

# create an index

curl -XPUT http://localhost:9200/my-index-name

# setup the package field mappings

cat mappings.json | curl -v -XPOST http://localhost:9200/my-index-name/package/_mapping -H "Content-type: application/json" -d @-

# setup an alias to 'registry'

curl -XPOST 'http://localhost:9201/_aliases' -d '

{

  "actions" : [

    { "add" : { "index" : "my-index-name", "alias" : "registry" } }

  ]

}'

```

## pipe the npm registry into elasticsearch

```

npm2es --couch="https://skimdb.npmjs.com/registry" --es="http://localhost:9200/registry"

```

## run the server

```

node bin/server.js --es="http://localhost:9200/registry"

```

## compute ratings

```

node bin/rating.js --es="http://localhost:9200/registry"

```

## Authors and Contributors

Elijah InsuaGitHub/tmpvarTwitter/@tmpvar

Authored by Elijah Insua. Contributions are welcomed from anyone wanting to improve this project!

## License & Copyright

**npmsearch** is Copyright (c) 2016 NodeSource and licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included [LICENSE.txt](LICENSE.txt) file for more details.