{"id":29020364,"url":"https://github.com/appbaseio/appbase-js","last_synced_at":"2025-07-15T18:45:46.267Z","repository":{"id":35490543,"uuid":"39760011","full_name":"appbaseio/appbase-js","owner":"appbaseio","description":"appbase.io search client library for JavaScript","archived":false,"fork":false,"pushed_at":"2023-10-27T21:48:40.000Z","size":4820,"stargazers_count":42,"open_issues_count":6,"forks_count":18,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2025-06-19T03:06:40.609Z","etag":null,"topics":["appbase","elasticsearch","javascript"],"latest_commit_sha":null,"homepage":"","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/appbaseio.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}},"created_at":"2015-07-27T07:01:17.000Z","updated_at":"2024-03-16T02:07:38.000Z","dependencies_parsed_at":"2022-08-04T03:30:23.164Z","dependency_job_id":null,"html_url":"https://github.com/appbaseio/appbase-js","commit_stats":null,"previous_names":[],"tags_count":53,"template":false,"template_full_name":null,"purl":"pkg:github/appbaseio/appbase-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fappbase-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fappbase-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fappbase-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fappbase-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appbaseio","download_url":"https://codeload.github.com/appbaseio/appbase-js/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fappbase-js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261978910,"owners_count":23239417,"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":["appbase","elasticsearch","javascript"],"created_at":"2025-06-26T01:05:27.301Z","updated_at":"2025-06-26T01:05:28.788Z","avatar_url":"https://github.com/appbaseio.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## ![Build Status Image](https://img.shields.io/badge/build-passing-brightgreen.svg)\n\n\u003ch2 id=\"top\" align=\"center\"\u003e\n  \u003cimg src=\"https://i.imgur.com/iiR9wAs.png\" alt=\"appbase-js\" title=\"appbase-js\" width=\"200\" /\u003e\n  \u003cbr /\u003e\n  appbase-js\n  \u003cbr /\u003e\n\u003c/h2\u003e\n\n[appbase-js](https://github.com/appbaseio/appbase-js) is a universal JavaScript client library for working with the appbase.io database, for Node.JS and Javascript (browser UMD build is in the [dist/](https://github.com/appbaseio/appbase-js/tree/master/dist) directory); compatible with [elasticsearch.js](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html).\n\nAn up-to-date documentation for Node.JS API is available at http://docs.appbase.io/javascript/quickstart.\n\n## TOC\n\n1. **[appbase-js: Intro](#1-appbase-js-intro)**\n2. **[Features](#2-features)**\n3. **[Live Examples](#3-live-examples)**\n4. **[Installation](#4-installation)**\n5. **[Docs Manual](#5-docs-manual)**\n6. **[Other Projects You Might Like](#6-other-projects-you-might-like)**\n\n\u003cbr /\u003e\n## 1. appbase-js: Intro\n\n[appbase-js](https://github.com/appbaseio/appbase-js) is a universal JavaScript client library for working with the appbase.io database.\n\n## 2. Features\n\nIt can:\n\n- Index new documents or update / delete existing ones.\n- Work universally with Node.JS, Browser, and React Native.\n\nIt can't:\n\n- Configure mappings, change analyzers, or capture snapshots. All these are provided by [elasticsearch.js](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html) - the official Elasticsearch JS client library.\n\n[Appbase.io - the database service](https://appbase.io) is opinionated about cluster setup and hence doesn't support the Elasticsearch devops APIs. See [rest.appbase.io](https://rest.appbase.io) for a full reference on the supported APIs.\n\n## 3. Live Examples\n\n\u003cbr /\u003e\n\u003cp\u003eCheck out the Live interactive Examples at \u003ca href=\"\nhttps://docs.appbase.io/api/examples/rest/\" target=\"_blank\"\u003ereactiveapps.io\u003c/a\u003e.\u003c/p\u003e\n\u003cbr/\u003e\n\n[![image](https://user-images.githubusercontent.com/57627350/128456523-7c964efc-8940-43bc-b3b5-142fc40bdf11.png)](https://docs.appbase.io/api/examples/rest/)\n\n## 4. Installation\n\nWe will fetch and install the **appbase-js** lib using npm. `4.0.0-beta` is the most current version.\n\n```js\nnpm install appbase-js\n```\n\nAdding it in the browser should be a one line script addition.\n\n```html\n\u003cscript\n  defer\n  src=\"https://unpkg.com/appbase-js/dist/appbase-js.umd.min.js\"\n\u003e\u003c/script\u003e\n```\n\nAlternatively, a UMD build of the library can be used directly from [jsDelivr](https://cdn.jsdelivr.net/npm/appbase-js/dist/).\n\nTo write data to [appbase.io](https://appbase.io), we need to first create a reference object. We do this by passing the appbase.io API URL, app name, and credentials into the `Appbase` constructor:\n\n```js\nvar appbaseRef = Appbase({\n  url: \"https://appbase-demo-ansible-abxiydt-arc.searchbase.io\",\n  app: \"good-books-demo\",\n  credentials: \"c84fb24cbe08:db2a25b5-1267-404f-b8e6-cf0754953c68\",\n});\n```\n\n**OR**\n\n```js\nvar appbaseRef = Appbase({\n  url: \"https://c84fb24cbe08:db2a25b5-1267-404f-b8e6-cf0754953c68@appbase-demo-ansible-abxiydt-arc.searchbase.io\",\n  app: \"good-books-demo\",\n});\n```\n\nCredentials can also be directly passed as a part of the API URL.\n\n## 5. Docs Manual\n\nFor a complete API reference, check out [JS API Ref doc](http://docs.appbase.io/javascript/apireference).\n\n## 6. Other Projects You Might Like\n\n- [**arc**](https://github.com/appbaseio/arc) API Gateway for ElasticSearch (Out of the box Security, Rate Limit Features, Record Analytics and Request Logs).\n\n- [**searchbox**](https://github.com/appbaseio/searchox) A lightweight and performance focused searchbox UI libraries to query and display results from your ElasticSearch app (aka index).\n\n  - **Vanilla JS** - (~16kB Minified + Gzipped)\n  - **React** - (~30kB Minified + Gzipped)\n  - **Vue** - (~22kB Minified + Gzipped)\n\n- [**dejavu**](https://github.com/appbaseio/dejavu) allows viewing raw data within an appbase.io (or Elasticsearch) app. **Soon to be released feature:** An ability to import custom data from CSV and JSON files, along with a guided walkthrough on applying data mappings.\n\n- [**mirage**](https://github.com/appbaseio/mirage) ReactiveSearch components can be extended using custom Elasticsearch queries. For those new to Elasticsearch, Mirage provides an intuitive GUI for composing queries.\n\n- [**ReactiveMaps**](https://github.com/appbaseio/reactivesearch/tree/next/packages/maps) is a similar project to Reactive Search that allows building realtime maps easily.\n\n- [**reactivesearch**](https://github.com/appbaseio/reactivesearch) UI components library for Elasticsearch: Available for React and Vue.\n\n[⬆ Back to Top](#top)\n\n\u003ca href=\"https://appbase.io/support/\"\u003e\u003cimg src=\"https://i.imgur.com/UL6B0uE.png\" width=\"100%\" /\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2Fappbase-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappbaseio%2Fappbase-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2Fappbase-js/lists"}