https://github.com/ipfs-search/ipfs-search-api

Microservice for searching the ipfs-search.com Elasticsearch index.
https://github.com/ipfs-search/ipfs-search-api

elasticsearch ipfs ipfs-search nodejs

Last synced: about 1 month ago
JSON representation

Microservice for searching the ipfs-search.com Elasticsearch index.

• Host: GitHub
• URL: https://github.com/ipfs-search/ipfs-search-api
• Owner: ipfs-search
• License: agpl-3.0
• Created: 2018-11-04T17:08:10.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T00:21:27.000Z (over 1 year ago)
• Last Synced: 2024-10-28T12:01:13.849Z (about 2 months ago)
• Topics: elasticsearch, ipfs, ipfs-search, nodejs
• Language: TypeScript
• Size: 1.24 MB
• Stars: 14
• Watchers: 4
• Forks: 8
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [ipfs-search.com](http://ipfs-search.com) search API

[![Maintainability](https://api.codeclimate.com/v1/badges/0f36e7a852c0266fc6c6/maintainability)](https://codeclimate.com/github/ipfs-search/ipfs-search-api/maintainability)

[![Backers on Open Collective](https://opencollective.com/ipfs-search/backers/badge.svg)](#backers)

 [![Sponsors on Open Collective](https://opencollective.com/ipfs-search/sponsors/badge.svg)](#sponsors)

Microservice for searching the ipfs-search.com Elasticsearch index.

## API Spec

[![swagger-api validator-badge](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/ipfs-search/ipfs-search-api/master/openapi.yaml)](./openapi-v1.yaml)

## Documentation

Statically generated documentation for the API can be found in the [docs](./docs/) folder and beautifully rendered interactive documentation is hosted at [Swagger](https://app.swaggerhub.com/apis/ipfs-search/ipfs-search).

## JavaScript/TypeScript client

There's a JavaScript/TypeScript client provided in the [client](./client/) folder and through [npm](https://www.npmjs.com/package/ipfs-search-client).

## Server

Open the [server](./server/) folder and run:

```shell

npm install

npm start

```

This will start an API server listening on port 9615, expecting Elasticsearh to be available on port 9200 on the localhost.