{"id":13652590,"url":"https://github.com/nervosnetwork/neuron","last_synced_at":"2025-04-08T10:26:44.087Z","repository":{"id":37359248,"uuid":"165770137","full_name":"nervosnetwork/neuron","owner":"nervosnetwork","description":"Neuron: Nervos CKB Wallet","archived":false,"fork":false,"pushed_at":"2025-04-04T00:26:14.000Z","size":58839,"stargazers_count":196,"open_issues_count":48,"forks_count":84,"subscribers_count":26,"default_branch":"develop","last_synced_at":"2025-04-04T10:52:16.031Z","etag":null,"topics":["blockchain","ckb","nervos","wallet"],"latest_commit_sha":null,"homepage":"https://www.nervos.org","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/nervosnetwork.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"COPYING","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":"2019-01-15T02:23:55.000Z","updated_at":"2025-04-03T19:06:50.000Z","dependencies_parsed_at":"2022-07-12T16:17:38.893Z","dependency_job_id":"6bb5d6a2-8474-4c9b-9c1b-ec3834135cc7","html_url":"https://github.com/nervosnetwork/neuron","commit_stats":{"total_commits":4161,"total_committers":41,"mean_commits":"101.48780487804878","dds":0.7077625570776256,"last_synced_commit":"9eca4399a5efd0c307b3a8adfe73df47311628c5"},"previous_names":[],"tags_count":122,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nervosnetwork%2Fneuron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nervosnetwork%2Fneuron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nervosnetwork%2Fneuron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nervosnetwork%2Fneuron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nervosnetwork","download_url":"https://codeload.github.com/nervosnetwork/neuron/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247822243,"owners_count":21001820,"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":["blockchain","ckb","nervos","wallet"],"created_at":"2024-08-02T02:01:00.747Z","updated_at":"2025-04-08T10:26:44.059Z","avatar_url":"https://github.com/nervosnetwork.png","language":"TypeScript","funding_links":[],"categories":["Tools"],"sub_categories":["Wallets"],"readme":"# Neuron\n\nNervos CKB Full-Node Desktop Wallet\n\n[![Unit Tests](https://github.com/nervosnetwork/neuron/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/nervosnetwork/neuron/actions/workflows/unit_tests.yml)\n[![Discord](https://img.shields.io/discord/956765352514183188?label=Discord\u0026logo=discord\u0026style=default\u0026color=grey\u0026labelColor=5865F2\u0026logoColor=white)](https://discord.gg/N9nZ3JE2Gg)\n\n---\n\n## Quick Start\n\n### Prerequisites\n\nYou will need `node \u003e= 18.12.0` and `yarn \u003e= 1.14` to build and run Neuron.\n\n#### Lerna\n\nThis project uses [lerna](https://github.com/lerna/lerna/) for package management.\n\n```shell\n$ yarn global add lerna # install lerna globally\n```\n\n#### Install Dependencies\n\n\u003e Notes: \n\u003e 1. Please set [proxy](https://www.electronjs.org/docs/latest/tutorial/installation#proxies) if you are using a proxy locally and find the downloading is halted\n\u003e 2. Please set [CDN](https://www.electronjs.org/docs/latest/tutorial/installation#mirror) if the downloading is slow\n\nAfter lerna has been installed, run this to install and link dependencies:\n\n```shell\n$ yarn\n$ lerna run rebuild:nativemodules\n```\n\n#### Add CKB Indexer\n\nCKB Indexer is a service to create cell and transaction indexes.\n\nDownload [CKB Indexer](https://github.com/nervosnetwork/ckb-indexer/releases) and move the binary into `packages/neuron-wallet/bin/{win/linux/mac}/`.\n\n### Start Neuron\n\nAs of `v0.26.0`, Neuron bundles a CKB binary and starts it for Mainnet automatically. If you prefer to run a local CKB node yourself instead, please follow the [Nervos CKB doc](https://docs.nervos.org/docs/basics/guides/mainnet) to get it up and running before launching Neuron.\n\n**Note**: If you run CKB node on Windows but it fails to start, you may need to download and install the latest [Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads).\n\n### Start Neuron in Development Mode\n\n```shell\n$ ./scripts/download-ckb.sh # Download CKB binary for your platform. Neuron will starts it automatically.\n$ yarn start\n```\n\nThis command starts `neuron-ui`, the React UI layer and `neuron-wallet`, the core wallet layer.\n\nYou can also start them independently:\n\n```shell\n# start neuron-ui at `http://localhost:3000`\n$ yarn start:ui\n```\n\n```shell\n# start neuron-wallet\n$ yarn start:wallet\n```\n\nIf you want to develop with devnet, replace the testnet script with the dev script in the `packages/neuron-wallet/.env` file.\n\nHere is a script env example, it is constructed by network、script name and filed name.\n\n```\nTESTNET_SUDT_DEP_TXHASH=0xe12877ebd2c3c364dc46c5c992bcfaf4fee33fa13eebdf82c591fc9825aab769\nTESTNET_SUDT_DEP_INDEX=0\nTESTNET_SUDT_DEP_TYPE=code\nTESTNET_SUDT_SCRIPT_CODEHASH=0xc5e5dcf215925f7ef4dfaf5f4b4f105bc321c02776d6e7d52a1db3fcd9d011a4\nTESTNET_SUDT_SCRIPT_HASHTYPE=type\n```\n\n### Test\n\n```shell\n$ yarn test\n```\n\n## Download Neuron Binary\n\nIf you don't want to bother building from source, you can download a binary from [releases](https://github.com/nervosnetwork/neuron/releases). We offer pre-built binaries for Windows, Linux and macOS.\n\n## License\n\nNeuron is released under the terms of the MIT license. See [COPYING](COPYING) for more information or see [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnervosnetwork%2Fneuron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnervosnetwork%2Fneuron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnervosnetwork%2Fneuron/lists"}