{"id":18338833,"url":"https://github.com/tableflip/interavatar","last_synced_at":"2025-04-09T20:36:00.573Z","repository":{"id":72910613,"uuid":"127425919","full_name":"tableflip/interavatar","owner":"tableflip","description":"Claim back your identity from the hashy anonymity, add an avatar to your IPFS peer ID.","archived":false,"fork":false,"pushed_at":"2018-03-30T12:30:17.000Z","size":30,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-15T12:46:48.356Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/tableflip.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":"2018-03-30T12:29:18.000Z","updated_at":"2018-12-10T23:17:17.000Z","dependencies_parsed_at":"2023-05-26T01:15:17.540Z","dependency_job_id":null,"html_url":"https://github.com/tableflip/interavatar","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tableflip%2Finteravatar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tableflip%2Finteravatar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tableflip%2Finteravatar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tableflip%2Finteravatar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tableflip","download_url":"https://codeload.github.com/tableflip/interavatar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248108425,"owners_count":21049129,"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":[],"created_at":"2024-11-05T20:15:44.585Z","updated_at":"2025-04-09T20:36:00.544Z","avatar_url":"https://github.com/tableflip.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Interavatar\n\n\u003e Inter Planetary Recognised Avatar\n\n## Get avatar\n\n`/ipns/interavatar.io/[peerId]` -\u003e (.jpg image)\n\n```js\nGET https://interavatar.io/avatar/{peerId}\n// -\u003e 303 https://gateway.interavatar.io/ipfs/Qmhash (.jpg image)\n```\n\nWe `ipfs.files.stat('/interavatar/{peerId}')` to get the hash of the file and then redirect to the gateway to return the contents.\n\nIn MVP https://gateway.interavatar.io is a CNAME to https://ipfs.io.\n\n## Create an avatar\n\n```js\nPUT https://interavatar.io/avatar/{peerId}\n// body - { avatar, password? }\n// peerId is a CID\n// avatar is a CID\n// password is an optional string for changing the avatar\n```\n\nClient side, we offer paste CID or upload. Upload will add to local js-ipfs so that we can send the added hash.\n\nWe'll use `window.ipfs` if available or download js-ipfs on demand if not.\n\nWe should put some restrictions on the file size/type.\n\n* In MVP there is no upload\n* In MVP there are no passwords\n\nServer side, we `ipfs.files.cp([payload.avatar, '/interavatar/' + params.peerId])` the file to MFS.\n\nWe periodically publish our IPFS node's name to be the hash of the `/interavatar` directory so that avatars can be looked up using IPNS: `/ipns/interavatar.io/[peerId]`.\n\nIn MVP we don't publish our name.\n\n## Update an avatar\n\n```js\nPATCH https://interavatar.io/avatar/{peerId}\n// body - { avatar, password? }\n// peerId is a CID\n// avatar is a CID\n// password is an optional string which must match the password sent with the PUT request\n```\n\nIn MVP we don't offer update.\n\n## Remove an avatar\n\n\u003e What does this mean on the permanent web?\n\n```js\nDELETE https://interavatar.io/avatar/{peerId}\n// body - { password? }\n// peerId is a CID\n// password is an optional string which must match the password sent with the PUT request\n```\n\nIn MVP we don't offer remove.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftableflip%2Finteravatar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftableflip%2Finteravatar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftableflip%2Finteravatar/lists"}