{"id":20759829,"url":"https://github.com/owsas/parse-server-addon-cloud-algolia","last_synced_at":"2025-04-30T05:21:01.422Z","repository":{"id":57319484,"uuid":"109470304","full_name":"owsas/parse-server-addon-cloud-algolia","owner":"owsas","description":"parse-server addon to sync your tables with algolia in Parse.Cloud","archived":false,"fork":false,"pushed_at":"2018-09-12T16:36:24.000Z","size":57,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-18T01:07:24.362Z","etag":null,"topics":["addon","algolia","algolia-search","parse","parse-server","parsesdk"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/owsas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-04T05:43:11.000Z","updated_at":"2023-08-26T11:24:42.000Z","dependencies_parsed_at":"2022-08-25T20:40:14.354Z","dependency_job_id":null,"html_url":"https://github.com/owsas/parse-server-addon-cloud-algolia","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owsas%2Fparse-server-addon-cloud-algolia","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owsas%2Fparse-server-addon-cloud-algolia/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owsas%2Fparse-server-addon-cloud-algolia/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owsas%2Fparse-server-addon-cloud-algolia/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/owsas","download_url":"https://codeload.github.com/owsas/parse-server-addon-cloud-algolia/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251284867,"owners_count":21564684,"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":["addon","algolia","algolia-search","parse","parse-server","parsesdk"],"created_at":"2024-11-17T10:08:27.716Z","updated_at":"2025-04-30T05:21:01.401Z","avatar_url":"https://github.com/owsas.png","language":"TypeScript","funding_links":["https://patreon.com/owsas"],"categories":[],"sub_categories":[],"readme":"# Parse Server Addon Cloud Algolia\n\n![Travis](https://travis-ci.org/owsas/parse-server-addon-cloud-algolia.svg?branch=master)\n\nTravis tests: https://travis-ci.org/owsas/parse-server-addon-cloud-algolia \n\nKeeps in sync your database with Algolia, adding new behaviours on the `afterSave` and `afterDelete` functions on the Cloud Code. \n\nThis is an addon for [ParseCloudClass](https://github.com/owsas/parse-cloud-class), and [parse-server](https://github.com/parse-community/parse-server)\n\n## Installation\n\n```\nnpm install --save parse-server-addon-cloud-class-algolia\n```\n\nNote: This package is Typescript friendly and comes with Intellisense :)\n\n## Features\n* Adds new objects in your class to algolia\n* Updates the objects in algolia when they change\n* Deletes the objects in algolia as they get removed from your database\n* Works for both PostgresSQL and MongoDB\n\n## How to use\n\nThis package requires you to check first `parse-server-addon-cloud-class` and how it works.\n\n```js\n// cloud/main.js\nimport { \n  ParseCloudClass \n} from 'parse-server-addon-cloud-class';\n\nimport { \n  AlgoliaCloudAddon \n} from 'parse-server-addon-cloud-class-algolia';\n\n\nconst algoliaAddon = new AlgoliaCloudAddon()\n  // initialize this with your credentials\n  .initialize('ALGOLIA_APP_ID', 'ALGOLIA_KEY', 'INDEX_NAME')\n  // set the keys you want to index in algolia\n  // for each of your objects\n  .setKeysToIndex([ 'name', 'location', 'numShares', 'otherObj' ]);\n\n\n// Now we create the configuration for our class. For more information, refer to its docs\n// here: https://github.com/owsas/parse-cloud-class\nconst classConfig = new ParseCloudClass();\nclassConfig.useAddon(algoliaAddon);\n\n\n// Now we finish configuring the class to \n// use our given configuration\nParseCloudClass.configureClass(Parse, 'MyParseClass', classConfig);\n```\n\n## The result\n\nYou will have a sync between your desired Parse class, stored in PostgreSQL or MongoDB and Algolia for efficient searching.\n\nThis addon will setup the following hooks:\n* __afterSave__\n* __afterDelete__\n\n\n## Extending the Algolia Cloud Addon\n\nYou can easily extend the Algolia Cloud Addon as it is a normal Javascript class, doing the following: \n\n```ts\nimport { \n  AlgoliaCloudAddon \n} from 'parse-server-addon-cloud-class-algolia';\n\nexport class MyModified extends AlgoliaCloudAddon {\n  // your new implementations to the lyfecycle functions\n}\n```\n\nNote: Check all the possibilities [here](https://github.com/owsas/parse-cloud-class)\n\n## Credits\n\nDeveloped by Juan Camilo Guarín Peñaranda,  \nOtherwise SAS, Colombia  \n2017\n\n## License \n\nMIT.\n\n## Support us on Patreon\n[![patreon](./repo/patreon.png)](https://patreon.com/owsas)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowsas%2Fparse-server-addon-cloud-algolia","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fowsas%2Fparse-server-addon-cloud-algolia","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowsas%2Fparse-server-addon-cloud-algolia/lists"}