{"id":41980205,"url":"https://github.com/globus/template-search-portal","last_synced_at":"2026-01-25T23:41:03.650Z","repository":{"id":222542464,"uuid":"757590476","full_name":"globus/template-search-portal","owner":"globus","description":"A template repository that can be used to create your own serverless search portal leveraging Globus Search and, optionally, Transfer.","archived":false,"fork":false,"pushed_at":"2024-12-20T15:57:34.000Z","size":327,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-20T16:44:55.925Z","etag":null,"topics":["portal","serverless"],"latest_commit_sha":null,"homepage":"https://globus.github.io/template-search-portal/","language":null,"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/globus.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-14T19:20:59.000Z","updated_at":"2024-12-20T15:57:38.000Z","dependencies_parsed_at":"2024-02-23T03:27:03.659Z","dependency_job_id":"743a5188-593d-40cc-82de-b6bf96e4af92","html_url":"https://github.com/globus/template-search-portal","commit_stats":null,"previous_names":["from-static-labs/example-search","globus/example-search-portal","globus/template-search-portal"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/globus/template-search-portal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Ftemplate-search-portal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Ftemplate-search-portal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Ftemplate-search-portal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Ftemplate-search-portal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/globus","download_url":"https://codeload.github.com/globus/template-search-portal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Ftemplate-search-portal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28761816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T23:06:19.311Z","status":"ssl_error","status_checked_at":"2026-01-25T23:03:50.555Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["portal","serverless"],"created_at":"2026-01-25T23:41:01.594Z","updated_at":"2026-01-25T23:41:03.644Z","avatar_url":"https://github.com/globus.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/globus/template-data-portal/assets/694253/8c55d1e3-1ecd-47ea-8288-73c79cd2c953\" height=\"100px\" alt=\"Globus\" /\u003e\n   \u003cbr/\u003e\n  \u003cstrong\u003e🧪 BETA 🧪\u003c/strong\u003e\n  \u003cbr/\u003e\n  \u003cstrong\u003eThis is a template repository used to generate a serverless Globus-powered research search portal.\u003c/strong\u003e\n  \u003cbr/\u003e\n\u003c/p\u003e\n\n----\n\nView the result at: [globus.github.io/template-search-portal](https://globus.github.io/template-search-portal).\n\nWhile this repository is a working example of a search portal, it is also a template for [creating your own research search portal](#creating-your-own-static-research-search-portal).\n\n----\n\n# Features + Functionality\n\n## Search Portal\n\n- **Powered by [Globus](https://www.globus.org/)**\n- Search for documents in a Globus Search Index with support for facets.\n- **Optional Authentication** – Authenticate users to access private Globus Search Indexes.\n- **Globus Transfer Integration** – Transfer files directly from the search portal to your Globus-connected storage.\n\n## GitHub Repository\n\n- 📄 **Hosted via GitHub Pages** – Users can access your data portal at this repository's GitHub Pages URL. Use all the functionality built-in to GitHub pages to suit your needs, including [configuring a custom domain](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages).\n\n- 🚀 **Automated Deployments via GitHub Actions** – Any file changes will result in the deployment (and rebuild) of your data portal.\n   - You can manually trigger a deployment by navigating to the **Actions** tab and selecting the **static** workflow.\n   \n- 🤖 **Dependabot** – A default [Dependabot](https://docs.github.com/en/code-security/dependabot) configuration ([`.github/dependabot.yml`](.github/dependabot.yml)) to keep your repository up-to-date with latest changes to [globus/static-search-portal](https://github.com/globus/static-search-portal).\n\n# Examples\nExample implementations of the Search Portal showing various capabilities – reviewing (and even copying) the `static.json` files can be a great starting point for your own portal.\n\n- [@globus/example-search-portal-with-embeds](https://github.com/globus/example-search-portal-with-embeds)\n- [@globus/example-search-portal-with-transfer](https://github.com/globus/example-search-portal-with-transfer)\n- [@globus/example-search-portal-with-github-action-ingest](https://github.com/globus/example-search-portal-with-github-action-ingest)\n\n# Creating Your Own Static Research Search Portal\n\n1. Create a new repository from the [globus/template-search-portal](https://github.com/globus/template-search-portal) template.\n   * Using the following URL: https://github.com/new?template_name=template-search-portal\u0026template_owner=globus\n   * \u003cimg width=\"188\" alt=\"Screenshot 2024-03-11 at 12 24 22 PM\" src=\"https://github.com/globus/template-data-portal/assets/694253/abffa5a5-86c8-47d9-be4b-f249d34505ab\"\u003e\n1. [Update your repository to allow publishing with GitHub Actions](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow).\n   - **IMPORTANT** The built-in GitHub Action workflows in your new repository will fail until you've updated this setting.\n1. [Ensure your GitHub Pages are configured to Enforce HTTPS](https://docs.github.com/en/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https)\n1. Update the `static.json` to include:\n   * `data.attributes.globus.search.index` – The Globus Search Index UUID that will be used source results from.\n   * Optional: Set the `data.attributes.globus.search.facets` to enable facet-based filtering.\n   * See the [static.json](#staticjson) type definitions for more configuration options.\n1. **That's it!** The changes made (and any future changes) to the `static.json` will trigger a GitHub Action that will automatically build and deploy your research data portal to your GitHub Pages URL.\n\n#### Private Globus Search Indexes (Authentication)\n\nIf your Globus Search Index is private, you'll want to include authentication to your portal.\n\n1. Register an application on Globus – https://app.globus.org/settings/developers\n   * You'll be creating an OAuth public client; This option is presented as _\"Register a thick client or script that will be installed and run by users on their devices\"_.\n   * Update the **Redirects** to include your GitHub Pages URL + `/authenticate`, i.e., `https://{username}.github.io/{repository}/authenticate`\n     * If you have [configured your GitHub Pages to use a custom domain](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), this will be `https://{domain}/authenticate`\n     * It is important to note that Globus Auth **requires HTTPS**.\n1. Update the `static.json` to include:\n   * `data.attributes.globus.application.client_id` – The UUID of the client created in **the previous step**.\n\n#### Common Changes after Creating Your Portal\n- **Result + Result Listing Rendering** – Update the `data.attributes.components.Result` and `data.attributes.components.ResultListing` to reference specific properties on your indexed data.\n- **Edit/Remove the `CITATION` file** – Update the [`CITATION.cff`](CITATION.cff) file to reflect the appropriate citation information for your research data portal – [learn more about `CITATION` files](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files).\n- **Removing this section of the README** – Remove this section from the `README.md` file or update the README to meet your needs.\n\n----\n\n### `static.json`\n\nThe type used for `data` by the [@globus/static-search-portal generator](https://github.com/globus/static-search-portal).\n\n#### Type declaration\n\nSee: https://github.com/globus/static-search-portal/blob/main/docs/type-aliases/Static.md\n\n#### Field Types\n\n#### Advanced Customization\n\n##### JSONata Support\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglobus%2Ftemplate-search-portal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglobus%2Ftemplate-search-portal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglobus%2Ftemplate-search-portal/lists"}