{"id":13630641,"url":"https://github.com/bitshares/bitshares-ui","last_synced_at":"2025-10-04T07:50:22.228Z","repository":{"id":1881635,"uuid":"44123296","full_name":"bitshares/bitshares-ui","owner":"bitshares","description":"Fully featured Graphical User Interface / Reference Wallet for the BitShares Blockchain","archived":false,"fork":false,"pushed_at":"2025-06-05T22:20:22.000Z","size":50062,"stargazers_count":519,"open_issues_count":444,"forks_count":569,"subscribers_count":75,"default_branch":"develop","last_synced_at":"2025-06-05T23:25:48.079Z","etag":null,"topics":["bitshares","bitshares-ui","blockchain","blockchain-wallet","cryptocurrency","javascript","reactjs","wallet","web-app"],"latest_commit_sha":null,"homepage":"https://wallet.bitshares.org","language":"JavaScript","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/bitshares.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2015-10-12T17:36:50.000Z","updated_at":"2025-06-05T22:20:20.000Z","dependencies_parsed_at":"2023-10-26T21:27:14.101Z","dependency_job_id":"f8a5fc44-b6a6-41fa-885f-e90e38a0f3ad","html_url":"https://github.com/bitshares/bitshares-ui","commit_stats":{"total_commits":8024,"total_committers":191,"mean_commits":"42.010471204188484","dds":0.7701894317048854,"last_synced_commit":"e6972e51611eed099749c515121159a8b7fcb078"},"previous_names":[],"tags_count":190,"template":false,"template_full_name":null,"purl":"pkg:github/bitshares/bitshares-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitshares%2Fbitshares-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitshares%2Fbitshares-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitshares%2Fbitshares-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitshares%2Fbitshares-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitshares","download_url":"https://codeload.github.com/bitshares/bitshares-ui/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitshares%2Fbitshares-ui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261123878,"owners_count":23113016,"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":["bitshares","bitshares-ui","blockchain","blockchain-wallet","cryptocurrency","javascript","reactjs","wallet","web-app"],"created_at":"2024-08-01T22:01:51.779Z","updated_at":"2025-10-04T07:50:17.186Z","avatar_url":"https://github.com/bitshares.png","language":"JavaScript","readme":"BitShares-UI\r\n============\r\n[中文版](README_zh.md)\r\n\r\nThis is the reference wallet of BitShares Blockchain which connects to BitShares Blockchain nodes (*bitshares-core*).\r\n\r\nThis reference wallet is a browser based wallet, which means *your keys are stored locally* in your browser and *never leaves it* while using the wallet. \r\nYou should *never expose your keys to anyone* as transactions are signed locally before transmitting them to a node.\r\n\r\n## Getting started\r\n\r\nBuilding BitShares-UI browser based reference wallet depends on node version 16 using a non-root user.\r\n\r\nOn Ubuntu or macOS, the easiest way to install node is to use [Node Version Manager](https://github.com/creationix/nvm).\r\n\r\nInstall nvm according to your platforms recommendation and set the version\r\n\r\n```\r\nnvm install v16\r\nnvm use v16\r\n```\r\n\r\nOnce you have node installed, clone the repository using the following commands:\r\n\r\n```\r\ngit clone https://github.com/bitshares/bitshares-ui.git\r\ncd bitshares-ui\r\n```\r\n\r\nBefore launching the UI you will need to install the packages using yarn on a non-root user:\r\n\r\n```\r\nyarn install\r\n```\r\n\r\n## Running the dev server\r\n\r\nOnce all the packages have been installed you can start the development \r\nserver by running:\r\n\r\n```\r\nyarn start\r\n```\r\n\r\nOnce the compilation is done the UI will be available in your browser at:\r\n`localhost:8080` or `127.0.0.1:8080`. Hot Reloading is enabled so the browser \r\nwill live update as you edit the source files.\r\n\r\n## Testnet\r\n\r\nBy default bitshares-ui connects to the BitShares mainnet, \r\nbut it's very easy to switch it to the testnet. \r\nTo do so, open the UI in a browser, go to Settings, then \r\nunder Nodes, select the *Testnet* in the dropdown menu. \r\nThe UI will reload and connect to the testnet.\r\n\r\nThere is also a ready-made deployment directly connected to testnet\r\nincluding account creation available [here](https://test.xbts.io/).\r\n\r\n![image](https://user-images.githubusercontent.com/33128181/175760811-736c9b21-9122-4160-bd30-465bb755a3a3.png)\r\n\r\n## Production\r\n\r\nIf you'd like to host your own UI somewhere, you should create a production \r\nbuild and host it using NGINX or Apache. \r\nIn order to create a prod bundle, simply run the following command:\r\n\r\n```\r\nyarn run build\r\n```\r\n\r\nThis will create a bundle in the ./build/dist folder that can be hosted with the web server of your choice.\r\n\r\n### Installable (local wallet)\r\n\r\nWe use Electron to provide installable wallets, available for Windows, macOS and Linux Debian platforms such as Ubuntu. \r\nThere is a [GitHub Action available](https://github.com/bitshares/bitshares-ui/blob/master/.github/workflows/build-release-binaries.yml#L18) that shows all the steps necessary for this build.\r\n\r\nThis will compile the UI with some special modifications for use with Electron, generate installable binaries with Electron and copy the result to the root `build/binaries` folder.\r\n\r\n### Docker\r\n\r\nClone this repository, run `docker-compose up` and visit localhost:8080\r\n\r\n## Contributing \u0026 Coding style guideline\r\n\r\nSee [CONTRIBUTING.md](CONTRIBUTING.md)\r\n\r\n## Code of Conduct\r\n\r\nThis repository has a Code of Conduct that should be followed by everyone. \r\nPlease read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)\r\n\r\n**Please keep comments constructive and clean**\r\n\r\n## BrowserStack \r\n\r\nThe BitShares UI is integrated with BrowserStack (https://www.browserstack.com) to allow manual compatibility testing across devices and browser versions. In the future we will switch to a automated Selenium testing framework.\r\n![image](https://user-images.githubusercontent.com/33128181/48697885-05f8d880-ebe6-11e8-95a2-d87516cbb3d9.png)\r\n\r\n## Release Branches\r\n\r\nThere are three branches that forms the current release process.\r\n\r\n### Develop\r\n\r\nAll PRs should be pushed to the `develop` branch.\r\nNew commits are automatically deployed to this branch and published for review.\r\n\r\nAvailable for browsing on https://develop.bitshares.org\r\n\r\n### Staging (Current Release Candidate)\r\n\r\nAt the end of each milestone, `develop` branch is pushed to staging and forms the Release Candidate. The date of the RC forms the name, ie. `5.0.220214-rc1`.\r\n\r\nApplication breaking issues and bugs should be submitted to the issue tracker and PRs should be pushed to `staging`.\r\n\r\nAvailable for browsing on https://staging.bitshares.org\r\n\r\n### Master (stable)\r\n\r\nWhen all major issues to the current RC are fixed, `staging` branch is released to the stable `master` branch.\r\n\r\nAvailable for browsing on https://wallet.bitshares.org which is the official reference wallet for Bitshares.\r\n","funding_links":[],"categories":["JavaScript","Utilities","Exchange-based Tokens"],"sub_categories":["Opensource Wallets"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitshares%2Fbitshares-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitshares%2Fbitshares-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitshares%2Fbitshares-ui/lists"}