{"id":29020316,"url":"https://github.com/appbaseio/reactivesearch-realm-function","last_synced_at":"2025-06-26T01:05:22.721Z","repository":{"id":39590613,"uuid":"395235545","full_name":"appbaseio/reactivesearch-realm-function","owner":"appbaseio","description":"Crate for ReactiveSearch API which creates a Realm function based API gateway","archived":false,"fork":false,"pushed_at":"2023-04-03T16:03:46.000Z","size":915,"stargazers_count":5,"open_issues_count":1,"forks_count":6,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-06-19T03:06:43.744Z","etag":null,"topics":["mongodb","reactivesearch","reactivesearch-api","realm","searchbox"],"latest_commit_sha":null,"homepage":"https://opensource.appbase.io/reactivesearch-realm-function/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appbaseio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-12T07:37:13.000Z","updated_at":"2024-07-13T16:19:12.000Z","dependencies_parsed_at":"2023-02-13T21:01:59.823Z","dependency_job_id":null,"html_url":"https://github.com/appbaseio/reactivesearch-realm-function","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/appbaseio/reactivesearch-realm-function","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-realm-function","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-realm-function/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-realm-function/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-realm-function/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appbaseio","download_url":"https://codeload.github.com/appbaseio/reactivesearch-realm-function/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-realm-function/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":["mongodb","reactivesearch","reactivesearch-api","realm","searchbox"],"created_at":"2025-06-26T01:05:21.948Z","updated_at":"2025-06-26T01:05:22.710Z","avatar_url":"https://github.com/appbaseio.png","language":"TypeScript","readme":"# ReactiveSearch Realm Function\n\n\nThe ReactiveSearch Realm project deploys the ReactiveSearch API as a transpiled JS code into a Realm function. The goal of this project is to enable Atlas Search users to be able to build search UIs using [Searchbox](https://opensource.appbase.io/searchbox) and [ReactiveSearch](https://opensource.appbase.io/reactivesearch) UI libraries.\n\n\u003e **Note on current project status:** This project is being actively developed and currently in a MVP stage where Atlas Search users can deploy the Realm function and run it with the React Searchbox library. Follow the below guides to get started and test this.\n\n## Setup\n\n- Clone repo: `git clone https://github.com/appbaseio/reactivesearch-realm-function.git`\n- Change working dir: `cd reactivesearch-realm-function`\n- Install dependencies: `npm i`\n- Start local build with hot reload: `npm start`\n- Test local build: `npm run start:test`\n\n## Local Testing\n\n- Add valid env `cp .env.sample .env`\n- Update env variables in `.env` file. `DB_URL` and `DB_NAME` are the required env\n- Start local server `npm run dev`\n- Local server exposes 2 endpoints to test the functionality\n  - `/:collection_name/_reactivesearch` -\u003e Endpoint to execute rs query and get mongo response. Sample output `{data: []}`. `collection_name` is dynamic param that one can pass against which query is to be executed\n  - `/:collection_name/_reactivesearch/validate` -\u003e Endpoint to validate rs query and get the aggregation pipleline in response.\n- Make `curl` / `rest` request\n\n  ```sh\n  curl --location --request POST 'http://localhost:8080/_reactivesearch' \\\n    --header 'Content-Type: application/json' \\\n    --data-raw '{\n        \"query\": [{\n            \"id\": \"search\",\n            \"type\": \"search\",\n            \"dataField\": \"*\",\n            \"size\": 5\n        }],\n        \"mongodb\": {\n            \"db\": \"sample_airbnb\",\n            \"collection\": \"listingsAndReviews\"\n        }\n    }'\n  ```\n\n## Deploy Project\n\nGo over the steps to deploy this project over [here](docs/deploy.md).\n\n## Static UI hosting\n\nGo over the steps to deploy the search UI with MongoDB App Services over [here](docs/static-hosting.md).","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2Freactivesearch-realm-function","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappbaseio%2Freactivesearch-realm-function","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2Freactivesearch-realm-function/lists"}