{"id":30309415,"url":"https://github.com/aprysesdk/pdftron-document-search","last_synced_at":"2025-08-17T13:43:49.043Z","repository":{"id":38665136,"uuid":"278485562","full_name":"ApryseSDK/pdftron-document-search","owner":"ApryseSDK","description":"Build search across multiple documents client-side in your file storage","archived":false,"fork":false,"pushed_at":"2023-03-30T22:16:58.000Z","size":77365,"stargazers_count":45,"open_issues_count":15,"forks_count":12,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-08-13T17:26:41.004Z","etag":null,"topics":["algolia-instantsearch","extract-text","seach-documents","search-office-text","search-pdf"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ApryseSDK.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-07-09T22:41:13.000Z","updated_at":"2025-07-05T10:59:16.000Z","dependencies_parsed_at":"2024-07-30T19:37:47.622Z","dependency_job_id":"3a94dba7-bf82-4743-8758-a74a412255e3","html_url":"https://github.com/ApryseSDK/pdftron-document-search","commit_stats":null,"previous_names":["aprysesdk/pdftron-document-search","pdftron/pdftron-document-search"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ApryseSDK/pdftron-document-search","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApryseSDK%2Fpdftron-document-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApryseSDK%2Fpdftron-document-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApryseSDK%2Fpdftron-document-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApryseSDK%2Fpdftron-document-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ApryseSDK","download_url":"https://codeload.github.com/ApryseSDK/pdftron-document-search/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApryseSDK%2Fpdftron-document-search/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270856590,"owners_count":24657693,"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","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["algolia-instantsearch","extract-text","seach-documents","search-office-text","search-pdf"],"created_at":"2025-08-17T13:43:48.285Z","updated_at":"2025-08-17T13:43:48.970Z","avatar_url":"https://github.com/ApryseSDK.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PDFTron Document Search\n\nPDFTron Document Search demonstrates building an application where users can search across multiple documents using:\n- [PDFTron PDF SDK](https://www.pdftron.com) for text extraction and viewing of the documents\n- [Firebase](https://firebase.google.com/) for storage\n- [Algolia](https://www.algolia.com/) for searching\n\nWatch [a quick video](https://youtu.be/IQATnzHTp7Q) that walks you throught the app. I also put together [a blog to help you get started](https://www.pdftron.com/blog/indexed-search/search-multiple-documents-using-javascript/).\n\n![Screenshot](https://github.com/PDFTron/pdftron-document-search/blob/master/search.png)\n\nThis repo is designed to help to get started in creating your own document searching workflow.\n\n## Install\n\n```\nnpm install\n```\n\n## Algolia Configuration\n\nThis application uses Algolia to search documents. However, be aware that Algolia is not the only third-party search provider. Consider alternatives such as [ElasticSearch](https://www.elastic.co/).\n\nTo get started with this sample, please register a new app with [Algolia](https://www.algolia.com/users/sign_up).\n\nCreate a new index called `document_search`:\n![Screenshot](https://github.com/PDFTron/pdftron-document-search/blob/master/algolia2.png)\n\nAfter you configured your app, create `.env` file in the root of the directory and place the following:\n\n```\nREACT_APP_ALGOLIA_APP_ID=your_key_goes_here\nREACT_APP_ALGOLIA_API_KEY=your_key_goes_here\nREACT_APP_ALGOLIA_SEARCH_KEY=your_key_goes_here\nREACT_APP_ALGOLIA_INDEX_NAME=document_search\n```\nThe above information can be found under API Keys in your Algolia Dashboard.\n![Screenshot](https://github.com/PDFTron/pdftron-document-search/blob/master/algolia.png)\n\n## Firebase Configuration\n\nThis application uses Firebase to store documents. You can use any other backend of your choice. \nHowever, to get started with this sample, please register a new app with [Firebase](https://firebase.google.com/).\n\nMake sure you create a storage bucket, and enable authentication for email and Google.\n![Screenshot](https://github.com/PDFTron/pdftron-sign-app/blob/master/firebase_authentication.png)\n\nAfter you have registered an app, create `.env` file in the root of the directory and place the following:\n\n```\nREACT_APP_API_KEY=your_key_goes_here\nREACT_APP_MESSAGING_SENDER_ID=your_key_goes_here\nREACT_APP_APP_ID=your_key_goes_here\nREACT_APP_AUTH_DOMAIN=your_domain_goes_here\nREACT_APP_DATABASE_URL=your_database_go_here\nREACT_APP_PROJECT_ID=your_project_id\nREACT_APP_STORAGE_BUCKET=your_storage_bucket\n```\nThe above information can be found under settings of your Firebase app.\n![Screenshot](https://github.com/PDFTron/pdftron-sign-app/blob/master/firebase.png)\n\nChange `Firestore Database` rules to:\n```\nrules_version = '2';\nservice cloud.firestore {\n  match /databases/{database}/documents {\n    match /{document=**} {\n      allow read, write: if request.auth != null;\n    }\n  }\n}\n```\n\nChange `Storage` rules to:\n```\nrules_version = '2';\nservice firebase.storage {\n  match /b/{bucket}/o {\n    match /{allPaths=**} {\n      allow read, write: if request.auth != null;\n    }\n  }\n}\n```\n\nNow you can run the application and start uploading your documents.\n\n## CORS\n\nYou will need to set up CORS on your Firestore to allow WebViewer to access files stored in your bucket. I created a CORS file called `cors.json`: \n\n```\n[\n  {\n    \"origin\": [\"*\"],\n    \"method\": [\"GET\"],\n    \"maxAgeSeconds\": 3600\n  }\n]\n```\n\nAnd then used gsutil to update it:\nhttps://cloud.google.com/storage/docs/configuring-cors\n\n## Run\n\n```\nnpm start\n```\n\n## Project structure\n\n```\nsrc/\n  app/             - Redux Store Configuration\n  components/      - React components\n    Navigate/            - Component responsible for navigating between different screens\n    PasswordReset/       - Reset password\n    Profile/             - Profile information and a sign out button\n    Search/              - Search previously uploaded documents\n    SignIn/              - Sign in\n    SignUp/              - Sign up\n    Upload               - Upload a document, which will be indexed for searching and saved to file storage.\n    View/                - View document with the search result highlighted\n  App              - Configuration for navigation, authentication\n  index            - Entry point and configuration for React-Redux\n  firebase/        - Firebase configuration for authentication, updating documents, storing PDFs\n  tools/           - Helper function to copy over PDFTron dependencies into /public on post-install\n```\n\n## API documentation\n\nSee [API documentation](https://www.pdftron.com/documentation/web/guides/ui/apis).\n\n## Contributing\n\nSee [contributing](./CONTRIBUTING.md).\n\n## License\n\nSee [license](./LICENSE).\n![](https://onepixel.pdftron.com/webviewer-ui)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faprysesdk%2Fpdftron-document-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faprysesdk%2Fpdftron-document-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faprysesdk%2Fpdftron-document-search/lists"}