{"id":13407270,"url":"https://github.com/raiden-network/webui","last_synced_at":"2025-05-05T14:31:19.453Z","repository":{"id":38984629,"uuid":"159179436","full_name":"raiden-network/webui","owner":"raiden-network","description":"Raiden's Web User Interface","archived":false,"fork":false,"pushed_at":"2025-04-29T20:44:22.000Z","size":7191,"stargazers_count":23,"open_issues_count":64,"forks_count":17,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-29T21:36:01.143Z","etag":null,"topics":["angular","raiden","raiden-webui","webui"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raiden-network.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-11-26T14:07:40.000Z","updated_at":"2023-05-12T01:56:29.000Z","dependencies_parsed_at":"2023-02-15T05:46:46.577Z","dependency_job_id":"44735ada-c23a-4d8b-9fcf-421e97474db4","html_url":"https://github.com/raiden-network/webui","commit_stats":{"total_commits":940,"total_committers":17,"mean_commits":"55.294117647058826","dds":"0.46702127659574466","last_synced_commit":"7a7916b5ef459b5f524f39fe439074dd156de6c7"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raiden-network%2Fwebui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raiden-network%2Fwebui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raiden-network%2Fwebui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raiden-network%2Fwebui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raiden-network","download_url":"https://codeload.github.com/raiden-network/webui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252514933,"owners_count":21760470,"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":["angular","raiden","raiden-webui","webui"],"created_at":"2024-07-30T20:00:35.025Z","updated_at":"2025-05-05T14:31:18.987Z","avatar_url":"https://github.com/raiden-network.png","language":"TypeScript","readme":"\u003c!-- PROJECT SHIELDS --\u003e\n\n\u003ch2 align=\"center\"\u003e\n  \u003cbr/\u003e\n  \u003ca href='https://raiden.network/'\u003e\u003cimg \n      width='400px' \n      alt='' \n      src=\"https://user-images.githubusercontent.com/35398162/54018436-ee3f6300-4188-11e9-9b4e-0666c44cda53.png\" /\u003e\u003c/a\u003e\n  \u003cbr/\u003e\n  Raiden WebUI\n  \u003cbr/\u003e\n\u003c/h2\u003e\n\n\u003ch4 align=\"center\"\u003e\n  \n\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e ∙\n  \u003ca href='#contact'\u003eContact\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://pypi.org/project/raiden-webui/\"\u003e\n    \u003cimg alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/raiden-webui.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://circleci.com/gh/raiden-network/webui/tree/master\"\u003e\n   \u003cimg src=\"https://circleci.com/gh/raiden-network/webui/tree/master.svg?style=svg\" alt=\"CircleCI Badge\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/raiden-network/webui\"\u003e\n    \u003cimg src=\"https://codecov.io/github/raiden-network/webui/coverage.svg?precision=2\" alt=\"Codecov Badge\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/prettier/prettier\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square\" alt=\"code style: prettier\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://gitter.im/raiden-network/raiden\"\u003e\n    \u003cimg src=\"https://badges.gitter.im/gitterHQ/gitter.png\" alt=\"Gitter Raiden Badge\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nRaiden WebUI is a simple web application that utilizes the Raiden REST API endpoints to\nallow the user to interact with token networks, make token payments, see the current status of open\nchannels along with closing and settling channels to name some of the functionality.\n\n## Table of Contents\n\n- [Table of Contents](#table-of-contents)\n- [About The Project](#about-the-project)\n- [Getting Started](#getting-started)\n  - [Learn about Raiden](#learn-about-raiden)\n  - [Using the WebUI](#using-the-webui)\n  - [Prerequisites](#prerequisites)\n  - [Development](#development)\n    - [Configuration](#configuration)\n    - [Running the WebUI](#running-the-webui)\n    - [Python package](#python-package)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n## About The Project\n\nThe [Raiden Network](https://raiden.network/) is an off-chain scaling solution, enabling near-instant,\nlow-fee and scalable payments. It’s complementary to the Ethereum blockchain and works with any ERC20 compatible token.\n\nThe Raiden client code is available [here](https://github.com/raiden-network/raiden) and has been\n[released for mainnet](https://medium.com/raiden-network/alderaan-mainnet-release-announcement-7f701e58c236) for the Alderaan release of the Raiden Network in May 2020.\n\n![Raiden WebUI](webui.gif)\n\nRaiden WebUI is built using the following technologies:\n\n-   [Angular](https://angular.io/)\n-   [Angular Material](https://material.angular.io/)\n-   [Angular Flex-Layout](https://github.com/angular/flex-layout)\n-   [Web3.js](https://github.com/ethereum/web3.js/)\n\n## Getting Started\n\n### Learn about Raiden\n\nIf you haven't used Raiden before, you can:\n\n-   Checkout the [developer portal](http://developer.raiden.network)\n-   Look at the [documentation](https://docs.raiden.network)\n-   Learn more by watching explanatory [videos](https://www.youtube.com/channel/UCoUP_hnjUddEvbxmtNCcApg)\n-   Read the blog posts on [Medium](https://medium.com/@raiden_network)\n\n### Using the WebUI\n\nIf you want to learn how to use the Raiden WebUI an [updated tutorial](https://raiden-network.readthedocs.io/en/latest/the-raiden-web-interface/the-raiden-web-interface.html) has been published in the documentation for Raiden.\n\n### Prerequisites\n\nIf you just want to use the WebUI all you need to do is install and run Raiden. A version of the WebUI comes bundled with each Raiden release and is accessible from `http://127.0.0.1:5001`.\n\nFor details on how to easily install Raiden:\n\nRead the [Quick Start](https://raiden-network.readthedocs.io/en/stable/installation/quick-start/) section in the documentation.\n\nIf you want to work on the WebUI codebase you need:\n\n-   Node \u003e=10.13.0\n-   A working [Raiden client](https://raiden-network.readthedocs.io/en/latest/overview_and_guide.html#installation).\n-   Git for version control.\n-   Yarn v1 for package management.\n\n### Development\n\nBefore you start working on the WebUI you need to install the WebUI dependencies.\n\n```bash\nyarn install\n```\n\n#### Configuration\n\nBefore you begin to work on the WebUI you have to make sure that you have the proper configuration.\nCheck if the [proxy configuration](./proxy.config.json) corresponds to your actual environment configuration.\n\nSince you will not be running the WebUI embedded into Raiden you need to provide both the Ethereum RPC endpoint\nand the Raiden REST API endpoint to the `proxy.config.json`.\n\nBy default the configurations looks like this:\n\n```json\n{\n    \"/api\": {\n        \"target\": \"http://localhost:5001\",\n        \"proxyTimeout\": 600000\n    },\n    \"/web3\": {\n        \"target\": \"http://localhost:8545\",\n        \"pathRewrite\": { \"^/web3\": \"\" },\n        \"changeOrigin\": true,\n        \"proxyTimeout\": 60000\n    }\n}\n```\n\nThe configuration assumes that the Ethereum RPC endpoint listens on `http://localhost:8545`\nand the Raiden REST API is on `http://localhost:5001`. If you are using a different configuration make sure\nto update the corresponding fields in the configuration.\n\nFor example if you run Raiden on port `5002` and you use Infura as your RPC provider you would have to\nmodify the `proxy.config.json` to like like:\n\n```json\n{\n    \"/api\": {\n        \"target\": \"http://localhost:5002\",\n        \"proxyTimeout\": 600000\n    },\n    \"/web3\": {\n        \"target\": \"http://goerli.infura.io/v3/YOUR_API_KEY\",\n        \"pathRewrite\": { \"^/web3\": \"\" },\n        \"changeOrigin\": true,\n        \"proxyTimeout\": 60000\n    }\n}\n```\n\n\u003e **Info**: On development mode there is no way to guarantee that raiden and the RPC provider run on the same chain.\n\u003e You have to be careful, because if you start for example Raiden on Rinkeby and pass Görli as the RPC endpoint, WebUI\n\u003e will fail to work.\n\n\u003e **Important**: Modifications on `proxy.config.json` make sure never be part of your PR.\n\n#### Running the WebUI\n\nAfter you are done with the configuration you can start the development server:\n\n```bash\nyarn run serve\n```\n\nAfter the development server starts you have to navigate to `http://localhost:4200/ui`, in order to use the WebUI.\n\n#### Python package\n\nThe WebUI is build as a python package and it's available on PyPI. This package is pinned as a dependency on Raiden.\nThe PyPI package provides a precompiled version of the WebUI that is bundled with Raiden and can be used out of the box.\n\nThe python package provides a static variable that points to the location of the WebUI static content root directory.\nThis can be imported by raiden to expose the bundled WebUI resources:\n\n```python\nfrom raiden_webui import RAIDEN_WEBUI_PATH\n```\n\nThe package can build the python package by calling:\n\n```bash\npython setup.py build sdist bdist_wheel\n```\n\nThe command calls `yarn build:prod` to build the static production version of the WebUI so\nthat it can get included in the python package.\n\nIf you need to install the package locally to your development virtual environment you can do\nso by running:\n\n```bash\npython setup.py build install\n```\n\nIn case you need to use the debug version of the WebUI within your virtual environment you can also\nrun:\n\n```bash\npython setup.py compile_webui -D install\n```\n\nThis will build the debug version of the WebUI to include in your package.\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nAlso have a look at the [Raiden WebUI Development Guide](./CONTRIBUTING.md) for more info.\n\n## License\n\nDistributed under the [MIT License](./LICENSE).\n\n## Contact\n\nDev Chat: [Gitter](https://gitter.im/raiden-network/raiden)\n\nTwitter: [@raiden_network](https://twitter.com/raiden_network)\n\nWebsite: [Raiden Network](https://raiden.network/)\n\nMail: contact@raiden.network\n\nProject Link: [https://github.com/raiden-network/light-client](https://github.com/raiden-network/light-client)\n","funding_links":[],"categories":["⚡ Developer Resources","Developer Resources"],"sub_categories":["Tools","🏗️ Tools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraiden-network%2Fwebui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraiden-network%2Fwebui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraiden-network%2Fwebui/lists"}