{"id":24005292,"url":"https://github.com/stare-js/stare.js-server","last_synced_at":"2025-04-15T01:37:45.605Z","repository":{"id":40710841,"uuid":"255193424","full_name":"StArE-js/stare.js-server","owner":"StArE-js","description":"StArE.js Server version","archived":false,"fork":false,"pushed_at":"2023-11-24T04:10:39.000Z","size":2928,"stargazers_count":1,"open_issues_count":26,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T07:04:54.031Z","etag":null,"topics":["node","node-js","nodejs","npm","npm-package","serp"],"latest_commit_sha":null,"homepage":"https://starejs.informatica.usach.cl/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StArE-js.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-13T00:06:57.000Z","updated_at":"2024-12-10T15:42:54.000Z","dependencies_parsed_at":"2024-09-19T01:44:45.392Z","dependency_job_id":null,"html_url":"https://github.com/StArE-js/stare.js-server","commit_stats":{"total_commits":117,"total_committers":4,"mean_commits":29.25,"dds":0.3589743589743589,"last_synced_commit":"ff9351c8428323783813d9303ba8553261d65ca7"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StArE-js%2Fstare.js-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StArE-js%2Fstare.js-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StArE-js%2Fstare.js-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StArE-js%2Fstare.js-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StArE-js","download_url":"https://codeload.github.com/StArE-js/stare.js-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248990470,"owners_count":21194761,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["node","node-js","nodejs","npm","npm-package","serp"],"created_at":"2025-01-08T02:36:56.118Z","updated_at":"2025-04-15T01:37:45.589Z","avatar_url":"https://github.com/StArE-js.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StArE.js (Node.js Server version)\n\n![npm](https://img.shields.io/npm/v/@stare.js/stare.js-server)\n![npm](https://img.shields.io/npm/dm/@stare.js/stare.js-server)\n[![Build Status](https://travis-ci.com/StArE-js/stare.js-server.svg?branch=master)](https://travis-ci.com/StArE-js/stare.js-server)\n[![Coverage Status](https://coveralls.io/repos/github/StArE-js/stare.js-server/badge.svg?branch=master)](https://coveralls.io/github/StArE-js/stare.js-server?branch=master)\n![NPM](https://img.shields.io/npm/l/@stare.js/stare.js-server)\n\n## Description\nStArE.js is an open source project intended to facilitate developers the creation of alternative visualizations of search engine results page (SERP). StArE.js provides a modular and extensible processing pipeline capable of (1) transforming SERP, (2) extracting features from individual search results, and (3) visualizing SERP in multiple ways.\n\n## Installation\n\n```bash\nnpm i @stare.js/stare.js-server\n```\n## How to use\n\n```js\nconst stare = require('@stare.js/stare.js-server')({...options});\n\nstare('google', 'What is love?', 10, ['ranking', 'language'])\n  .then(result =\u003e {\n    console.log(result);\n  })\n  .catch(err =\u003e {\n    console.error(err);\n  });\n```\n\nWhere the arguments of the funtction are:\n\n| Argument | Type | Description |\n| ----- | ----- | ----- |\n| engine | \u003ccode\u003eString\u003c/code\u003e | Search Engine to use (requires previous configuration for some cases) |\n| query |\u003ccode\u003eString\u003c/code\u003e | Search Query (self explanatory)\n| number of results to show | \u003ccode\u003eNumber\u003c/code\u003e | Maximun numbers of documents/results to get from the engine |\n| metrics | \u003ccode\u003eArray\u003c/code\u003e | Metrics to get from each document |\n\nYou can find the most basic full example in the [examples folder](/examples/).\n\n## Resources\n\n* [npm package](https://www.npmjs.com/package/@stare.js/stare.js-server)\n* [Documentation](/docs/)\n* [Examples](/examples/)\n\n## Extensions\n\nStArE.js is currently extended with the following plugins:\n\n### SERPs\n\n| SERP | Function name | Description | Documentation |\n| ------ | ------ | ------ | ------ |\n| Google | \u003ccode\u003egoogle\u003c/code\u003e | Handler for SERPs obtained through the Google Custom Search JSON API | [See docs](/docs/SERP.md#google) |\n| Bing | \u003ccode\u003ebing\u003c/code\u003e | Handler for SERPs obtained through the Bing web search API | [See docs](/docs/SERP.md#bing) |\n| Ecosia | \u003ccode\u003eecosia\u003c/code\u003e | Handler for SERPs obtained from ecosia through a web scrapper | [See docs](/docs/SERP.md#ecosia) |\n| ElasticSearch | \u003ccode\u003eelasticsearch\u003c/code\u003e | Handler for SERPs obtained from ElasticSearch (only basic support) via request-promise | [See docs](/docs/SERP.md#elasticsearch) |\n| Solr | \u003ccode\u003esolr\u003c/code\u003e | Handler for SERPs obtained from Solr (only basic support) via request-promise | [See docs](/docs/SERP.md#solr) |\n| AWS Search Cloud | \u003ccode\u003esearchcloud\u003c/code\u003e | Handler for SERPs obtained from AWS Search Cloud (only basic support) via request-promise | [See docs](/docs/SERP.md#searchcloud) |\n\n| Metrics | Metric name | Description | Documentation |\n| ------ | ------ | ------ | ------ |\n| Perspicuity | \u003ccode\u003eperspicuity\u003c/code\u003e | Reading Ease for English and Perspicuity for Spanish | [See docs](/docs/METRICS.md#perspicuity) |\n| Language | \u003ccode\u003elanguage\u003c/code\u003e | Detect the most probable language for a document | [See docs](/docs/METRICS.md#language) |\n| Length of Documents | \u003ccode\u003elength\u003c/code\u003e | Calculate the length in characters of a Document | [See docs](/docs/METRICS.md#length) |\n| Ranking | \u003ccode\u003eranking\u003c/code\u003e | Calculate the length in characters of a Document | [See docs](/docs/METRICS.md#ranking) |\n| Keywords Position | \u003ccode\u003ekeywords-position\u003c/code\u003e | Gets the position of the query terms (keywords) inside the text body of the document | [See docs](/docs/METRICS.md#keywords-position) |\n| Links | \u003ccode\u003elinks\u003c/code\u003e | Gets the relation between the documents based on the url that the text body contains. Only for HTML documents. | [See docs](/docs/METRICS.md#links) |\n| Multimedia | \u003ccode\u003emultimedia\u003c/code\u003e | Gets the amount of multimedia data on the document (audio, video, images) that the text body contains. Only for HTML documents. | [See docs](/docs/METRICS.md#multimedia) |\n\nAs is explained in the docs you can create your own extensions for [SERP](/docs/SERP.md#create-your-own-extensions) and [metrics](/docs/METRICS.md#create-your-own-extensions) support.\n\nPlease read the full documentation [here](/docs/INDEX.md).\n\n## Debug / Logging\n\nStArE.js is powered by [debug](https://github.com/visionmedia/debug).\nIn order to see all the debug output, run your app with the environment variable\n`DEBUG` including the desired scope.\n\nTo see the output from all of StArE.js's debugging scopes you can use:\n\n```\nDEBUG=stare.js\n```\n\n## Contributors\n\n- [Roberto González-Ibáñez](https://github.com/rgonzal/)\n- [Camila Márquez](https://github.com/bellyster/)\n- [Daniel Gacitúa](https://github.com/dgacitua/)\n- [Franz Farbinger](https://github.com/DarkAnimat/)\n- [Diego Salazar S.](https://github.com/d-salazar-se/)\n\n## License\n[MIT](LICENSE)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstare-js%2Fstare.js-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstare-js%2Fstare.js-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstare-js%2Fstare.js-server/lists"}