{"id":13632077,"url":"https://github.com/radicle-dev/radicle-interface","last_synced_at":"2025-04-18T01:32:27.898Z","repository":{"id":37733550,"uuid":"341620995","full_name":"radicle-dev/radicle-interface","owner":"radicle-dev","description":"Radicle web interface","archived":false,"fork":false,"pushed_at":"2024-04-09T12:05:33.000Z","size":7916,"stargazers_count":84,"open_issues_count":0,"forks_count":27,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-17T03:02:23.002Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://app.radicle.xyz","language":"Svelte","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/radicle-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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}},"created_at":"2021-02-23T16:41:35.000Z","updated_at":"2024-04-18T09:46:43.252Z","dependencies_parsed_at":"2023-10-04T15:08:28.850Z","dependency_job_id":"9284bae9-afae-4712-81ab-03e8fe17d28a","html_url":"https://github.com/radicle-dev/radicle-interface","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/radicle-dev%2Fradicle-interface","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radicle-dev%2Fradicle-interface/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radicle-dev%2Fradicle-interface/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radicle-dev%2Fradicle-interface/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/radicle-dev","download_url":"https://codeload.github.com/radicle-dev/radicle-interface/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223772124,"owners_count":17199968,"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-08-01T22:02:50.600Z","updated_at":"2024-11-09T00:30:37.145Z","avatar_url":"https://github.com/radicle-dev.png","language":"Svelte","funding_links":[],"categories":["Svelte"],"sub_categories":[],"readme":"# Radicle Explorer\n\nThis user interface lets you interact with [Radicle][rad], a peer-to-peer code\ncollaboration and publishing stack, directly from your web browser.\n\n**Deployment Options:**\n\n* **Public Server:** The Radicle team maintains a public instance at [app.radicle.xyz][app]\n* **Local-first:** Run the UI locally\n* **Self-hosting:** Deploy the UI on your own server\n\n\n## Local-first\n\n**Prerequisites:**\n\n* Recent versions of [Node.js][nod] (20.9.0 or higher) and [npm][npm] installed\n\nRun the following commands to access the web UI locally:\n\n``` shell\ngit clone https://seed.radicle.xyz/z4V1sjrXqjvFdnCUbxPFqd5p4DtH5.git radicle-explorer\ncd radicle-explorer\nnpm install\nnpm start\n```\n\nThen open http://localhost:3000 in your favourite browser.\n\n\n## Self-Hosting the UI\n\nThere are several ways to deploy the UI publicly. Here are two common options:\n\n**Using your own web server:**\n\n1. Run `npm install \u0026\u0026 npm build` to create a build for deployment\n2. Configure your web server to serve the contents of the `/build` directory\n\n**Using Vercel (or similar static file hosting):**\n\n1. Fork this repository to create your own version\n2. Configure your Vercel account to deploy the forked repository\n\n## Configuration\n\nThere's two ways to configure the UI:\n\n**Create a `local.json` config file**\n\n1. Copy [default.json][def] to a new file in the same folder called\n   `local.json`.\n2. Modify the properties in `local.json` to your preference.\n\n**Environment variables**\n\n1. Check [custom-environment-variables.json][env] for all available environment\n   variables.\n2. Set the desired environment variables when building the UI.\n\n\u003e For advanced configuration options, have a look at the [`node-config`][nco]\n\u003e package.\n\n## Contributing\n\n* For detailed contribution guidelines, refer to the [CONTRIBUTING.md][con]\n  file\n* To propose changes, open an [issue][iss] or submit a [patch][pat] using\n  Radicle\n\n\n## Getting in touch\n\nTo get in touch with the maintainers, sign up to our\n[official chat on Zulip][zul].\n\n\n## License\n\nThe UI is distributed under the terms of GPLv3. See [LICENSE][lic] for details.\n\n\n\n[app]: https://app.radicle.xyz\n[con]: ./CONTRIBUTING.md\n[def]: ./config/default.json\n[env]: ./config/custom-environment-variables.json\n[iss]: https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z4V1sjrXqjvFdnCUbxPFqd5p4DtH5/issues\n[lic]: ./LICENSE\n[nco]: https://github.com/node-config/node-config/wiki/Configuration-Files\n[nod]: https://nodejs.org\n[npm]: https://www.npmjs.com\n[pat]: https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z4V1sjrXqjvFdnCUbxPFqd5p4DtH5/patches\n[rad]: https://radicle.xyz\n[zul]: https://radicle.zulipchat.com/#narrow/stream/369278-web\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradicle-dev%2Fradicle-interface","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fradicle-dev%2Fradicle-interface","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradicle-dev%2Fradicle-interface/lists"}