{"id":14956116,"url":"https://github.com/ipfs/ipfs-gui","last_synced_at":"2025-10-01T17:30:52.122Z","repository":{"id":28107129,"uuid":"111841602","full_name":"ipfs/ipfs-gui","owner":"ipfs","description":"Creating standards and patterns for IPFS that are simple, accessible, reusable, and beautiful","archived":false,"fork":false,"pushed_at":"2024-01-31T17:34:00.000Z","size":16543,"stargazers_count":105,"open_issues_count":35,"forks_count":17,"subscribers_count":32,"default_branch":"main","last_synced_at":"2024-10-29T11:00:27.433Z","etag":null,"topics":["ipfs","ipfs-gui"],"latest_commit_sha":null,"homepage":"","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/ipfs.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-23T18:54:22.000Z","updated_at":"2024-10-16T14:40:29.000Z","dependencies_parsed_at":"2024-08-05T16:11:33.615Z","dependency_job_id":null,"html_url":"https://github.com/ipfs/ipfs-gui","commit_stats":{"total_commits":111,"total_committers":13,"mean_commits":8.538461538461538,"dds":0.6936936936936937,"last_synced_commit":"cf9a556922dfe7b1996d9d2df11f52133d19647b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fipfs-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fipfs-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fipfs-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fipfs-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ipfs","download_url":"https://codeload.github.com/ipfs/ipfs-gui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227351573,"owners_count":17768419,"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":["ipfs","ipfs-gui"],"created_at":"2024-09-24T13:12:20.473Z","updated_at":"2025-10-01T17:30:45.977Z","avatar_url":"https://github.com/ipfs.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# IPFS GUIs\n\n[![Made by icon.](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat)](https://protocol.ai/)\n[![Project icon.](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat)](http://ipfs.io/)\n[![#ipfs](https://img.shields.io/badge/irc-%23ipfs-brightgreen.svg)](https://webchat.freenode.net/?channels=ipfs) \u003ca href=\"https://www.irccloud.com/invite?channel=%23ipfs-gui\u0026amp;hostname=irc.freenode.net\u0026amp;port=6697\u0026amp;ssl=1\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/irc-%23ipfs--gui-brightgreen.svg?style=flat\"  height=\"20\"\u003e\u003c/a\u003e\n\nThe IPFS project has an ongoing, long-running ambition to **create visual and interaction standards and patterns for working with IPFS that are ...**\n\n- **Simple**: Present the big ideas of IPFS clearly, without unnecessary complexity\n- **Accessible**: Enable *everyone* to take advantage of what IPFS offers\n- **Reusable**: Offer compelling standards and atomic patterns to the community of IPFS builders\n- **Beautiful**: By their nature, things that are simple, accessible and reusable are also beautiful\n\n## IPFS GUI projects\n\n### Primary projects\n\nAt present, primary focus is on the three \"helper\" apps that provide a GUI for IPFS as a whole, in order to make them useful for seasoned IPFS developers while also offering a welcoming introduction to IPFS for those less experienced.\n\n| IPFS Companion | IPFS Web UI | IPFS Desktop |\n|:-:|:-:|:-:|\n| [\u003cimg title=\"IPFS Companion\" src=\"https://ipfs.io/images/ipfs-companion-hex.png\" /\u003e][IPFS Companion] | [\u003cimg title=\"Web UI screenshot\" src=\"img/webui-hex.png\" /\u003e][IPFS Web UI] | [\u003cimg title=\"IPFS Desktop\" src=\"https://ipfs.io/images/ipfs-desktop-hex.png\" /\u003e][IPFS Desktop] |\n| [Browser extension](https://github.com/ipfs/ipfs-companion) for opening ipfs:// URLs, saving/sharing files, and more| [IPFS file manager and network explorer](https://github.com/ipfs-shipyard/ipfs-webui) in your browser | Launch and manage IPFS from a friendly, intuitive [desktop app](https://www.github.com/ipfs-shipyard/ipfs-desktop) |\n\nFor a more comprehensive overview of the resources that come together to build, support, and provide education around Web UI, Desktop, and Companion, please see the [IPFS GUI Family Mental Model](https://ipfs-gui-mental-model.netlify.app/) and our [June 2020 user research report](https://docs.google.com/document/d/1V5sDSxMqhhplpcB8u8CffiGWHUvw-t4p_sn5vigdR90/edit#).\n\n### Other IPFS GUI \u0026 Tools owned projects\n\n- **[ipfs/ipfs-gui](https://www.github.com/ipfs/ipfs-gui)**: This repo, used for overall planning and cross-repo work\n- **[ipfs/distributions/site](https://github.com/ipfs/distributions/tree/master/site)**: Visual side of https://dist.ipfs.io website\n- **[ipfs/public-gateway-checker](https://www.github.com/ipfs/public-gateway-checker)**: Source code for https://ipfs.github.io/public-gateway-checker/\n- **[ipfs/ipfs-companion](https://github.com/ipfs/ipfs-companion)**: Browser extension that simplifies access to IPFS resources on the Web\n- **[ipfs/ipfs-webui](https://github.com/ipfs/ipfs-webui)**: Browser front-end for IPFS nodes\n- **[ipfs/ipfs-desktop](https://github.com/ipfs/ipfs-desktop)**: An unobtrusive and user-friendly desktop application for IPFS on Windows, Mac and Linux\n- **[ipld/explore.ipld.io](https://github.com/ipld/explore.ipld.io)**: Source code for https://explore.ipld.io\n  - **[ipfs/ipld-explorer-components](https://github.com/ipfs/ipld-explorer-components)**: React components for https://explore.ipld.io and ipfs-webui\n- **[ipfs-shipyard/i18n](https://github.com/ipfs-shipyard/i18n)**: Internationalization work across all IPFS projects\n- **[ipfs-shipyard/ipfs-css](https://www.github.com/ipfs-shipyard/ipfs-css)**: Single-purpose CSS rules and font-face config to add the IPFS look and feel to your UI\n- **[ipfs-shipyard/pinning-service-compliance](https://www.github.com/ipfs-shipyard/pinning-service-compliance)**: A test suite to help see which pinning service providers are correctly implementing the [pinning services spec](https://ipfs.github.io/pinning-services-api-spec/).\n- **[ipfs-shipyard/js-pinning-service-http-client](https://github.com/ipfs-shipyard/js-pinning-service-http-client)**: A pinning service client for the browser and node\n- **[ipfs-shipyard/ipfs-dag-builder-vis](https://github.com/ipfs-shipyard/ipfs-dag-builder-vis)**: A tool for creating \u0026 modifying IPFS DAG structures visually. See https://dag.ipfs.tech/ \n- **[multiformats/cid-utils-website](https://github.com/multiformats/cid-utils-website)**: A website for decoding CIDs. See https://cid.ipfs.tech/#bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi\n\n\n\n### Other GUI projects\n\nIn addition to the apps \u0026 repos above, other relevant GUI related tools/apps that are not owned by the IPFS GUI \u0026 Tools team are:\n\n- **[kubo/dir-index-html](https://github.com/ipfs/go-ipfs/tree/master/assets/dir-index-html)**: Directory listing HTML for kubo (go-ipfs) gateways\n- **[filecoin-station/filecoin-station](https://github.com/filecoin-station/filecoin-station)**: Filecoin Station connects your computer’s idle resources to the Filecoin network and rewards you with FIL. Taking part is simple, just launch the app and start earning.\n- **[ipfs-shipyard/ipfs-check](https://github.com/ipfs-shipyard/ipfs-check)**: A tool for checking the accessibility of your data by IPFS peers\n- **[laurentsenta/pl-diagnose](https://github.com/laurentsenta/pl-diagnose)**: Reimplementation \u0026 extension of https://github.com/aschmahmann/ipfs-check\n- **[ipfs-shipyard/ipfs-ui-style-guide](https://www.github.com/ipfs-shipyard/ipfs-ui-style-guide)**: UI style guide for IPFS apps\n- **[ipfs-shipyard/ipfs-share-files](https://www.github.com/ipfs-shipyard/ipfs-share-files)**: Source code for https://share.ipfs.io\n\n### Visual design guidelines\n\n[![IPFS-Brand-sheet-public](https://user-images.githubusercontent.com/157609/176955199-0f87b9bc-3a8d-4bd0-b9a3-48a9fe38f942.png)](https://www.figma.com/proto/mH0OlgikgKzLmbMNO3noBs/IPFS-Brand-sheet-public)\n\n- [Figma IPFS brand sheet](https://www.figma.com/proto/mH0OlgikgKzLmbMNO3noBs/IPFS-Brand-sheet-public)\n  - [Download PDF (2022)](https://ipfs.io/ipfs/QmcVRX6eArMmyTo2LQ5iDGD1BJ13FwFv8EB1oGaVmSwbwE?filename=ipfs-brand-sheet-2022.pdf)\n  - [Download Assets (2022)](https://ipfs.io/ipfs/QmSwE3QkkQf914n3RRMtCprxS8qMTtxEWFHneYppdAukeR?filename=ipfs-brand-assets-2022.zip)\n\n## Get involved!\n\n### Contribute to an issue\n\nContributions to IPFS GUIs are more than welcome! Each of the repos listed under [\"All projects\"](#all-projects) above makes use of the IPFS Project's [global issue labeling scheme](https://github.com/ipfs/community/blob/master/ISSUE_LABELS.md). Good labels to look for are ...\n- `help wanted`\n- `good first issue`\n- and there are even occasional `bounty` labels for issues with rewards as part of the [IPFS Bounty Board](https://github.com/ipfs/devgrants/projects/1)!\n\nIf you see an issue that catches your eye, leave a comment so we know you're interested, and we'll go from there!\n\nWe're an open project and a friendly group, so please be nice and **read the [contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)** when you're ready to jump in.\n\n### Discuss in GitHub or chat\n\n**For the sake of async communication, archiving, and searchability, we strongly encourage discussions to happen in the context of GitHub issue comments whenever practical.**\n\nFor casual conversation, our official chat rooms in [Matrix](https://app.element.io/#/room/#lobby:ipfs.io) and [Discord](https://discord.gg/Z4H6tdECb9) are bridged, so you can join whichever you prefer. They can be used to ask questions and discuss with the community — however, while IPFS core developers are usually in these rooms, it can be hard to keep up with the running conversation and questions can be missed or disappear due to a lack of indexing.\n\n## Resources\n\nIf you're looking for high-level research or visual and brand info:\n\n- [IPFS brand sheet](https://www.figma.com/proto/mH0OlgikgKzLmbMNO3noBs/IPFS-Brand-sheet-public?node-id=22%3A2)\n  - see also: [Protocol Labs branding and visual design index](https://www.figma.com/proto/zwiBoppEK16FXV89bqDVgX/PL-%2B-project-branding-master-index?node-id=0%3A6\u0026scaling=min-zoom)\n\nAlso, these historical resources may be helpful:\n\n- [IPFS GUI Family Mental Model](https://ipfs-gui-mental-model.netlify.app/): June 2020 framework for understanding how IPFS’ various GUI-based tools work together to provide cohesive, consistent enablers to using and building on IPFS for a variety of developer and non-developer stakeholder groups\n- [June 2020 user research report](https://docs.google.com/document/d/1V5sDSxMqhhplpcB8u8CffiGWHUvw-t4p_sn5vigdR90/edit#): Survey analysis offering guidance on next actions for enhancements to the IPFS GUI tool family\n- [Original GUI project research](research): Spring 2018 foundational research on IPFS GUIs, including the initial definition of this group's goals\n- [IPFS color palette](https://github.com/ipfs-shipyard/ipfs-css#colors): Official IPFS colors as part of [`ipfs-css`](https://github.com/ipfs-shipyard/ipfs-css)\n- [IPFS logo files](https://github.com/ipfs-inactive/logo): Vector and raster logo assets\n- [IPFS brand book](https://github.com/ipfs-shipyard/ipfs-ui-style-guide/files/1629262/IPFS_brandbook.pdf): IPFS-wide brand guidance, including logo guidelines\n- [IPFS UI Summary](img/ipfs-ui-kit.png): Alpha-version UI style guide summary\n\n## Maintainers\n\nThis `ipfs-gui` repo is intended primarily as a higher-order planning and discussion space, so isn't actively maintained in and of itself; however, consult the readmes of the repos listed under [\"All projects\"](#all-projects) above for more specific maintainer info for individual projects.\n\n\n\n[IPFS Web UI]: https://github.com/ipfs-shipyard/ipfs-webui \"Web-based IPFS file manager and network explorer\"\n[IPFS Desktop]: https://github.com/ipfs-shipyard/ipfs-desktop \"Launch and manage IPFS from a desktop app\"\n[IPFS Companion]: https://github.com/ipfs/ipfs-companion \"Integrate IPFS with your browser\"\n\n## Support goals\n\n### Platforms\n\nDue to the difficulty involved in debugging and development on platforms and versions not supported by github actions (and our CI/CD tests), we can only provide support for the [top 3 (mac, windows, ubuntu) `latest` platforms supported by github](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources). \n\nIf there is a new platform release, we will support bug-fixes and feature enhancements for that new platform, but will prioritize bug-fixes for things we can automate (CI/CD supported bugs/features).\n\n### Languages\n\nDue to a large demand and lack of time, as a general rule, we aim to support the latest (or most popular) officially supported versions of languages. \n\n#### NodeJS\n\n\u003e Production applications should only use Active LTS or Maintenance LTS releases.\n\nSee https://nodejs.org/en/about/releases/ for the officially supported NodeJS Versions. We aim to support Active LTS or Maintenance LTS versions with a best-effort support for Current versions.\n\nSupport priority:\n\n1. Active LTS\n2. Maintenance LTS\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs%2Fipfs-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fipfs%2Fipfs-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs%2Fipfs-gui/lists"}