{"id":13499283,"url":"https://github.com/jamaljsr/polar","last_synced_at":"2026-01-06T17:28:42.068Z","repository":{"id":37396687,"uuid":"201514509","full_name":"jamaljsr/polar","owner":"jamaljsr","description":"One-click Bitcoin Lightning networks for local app development \u0026 testing","archived":false,"fork":false,"pushed_at":"2025-05-09T03:37:58.000Z","size":49512,"stargazers_count":813,"open_issues_count":47,"forks_count":155,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-05-09T04:27:31.998Z","etag":null,"topics":["bitcoin","bitcoind","c-lightning","docker","electron","lightning","lightning-network","lnd","polar","react"],"latest_commit_sha":null,"homepage":"https://lightningpolar.com","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/jamaljsr.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":"2019-08-09T17:40:08.000Z","updated_at":"2025-05-09T03:36:51.000Z","dependencies_parsed_at":"2023-12-22T19:26:03.614Z","dependency_job_id":"16ede5e5-fde8-4839-902d-59374b7bcee2","html_url":"https://github.com/jamaljsr/polar","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamaljsr%2Fpolar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamaljsr%2Fpolar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamaljsr%2Fpolar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamaljsr%2Fpolar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jamaljsr","download_url":"https://codeload.github.com/jamaljsr/polar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254235701,"owners_count":22036964,"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":["bitcoin","bitcoind","c-lightning","docker","electron","lightning","lightning-network","lnd","polar","react"],"created_at":"2024-07-31T22:00:31.821Z","updated_at":"2026-01-06T17:28:42.061Z","avatar_url":"https://github.com/jamaljsr.png","language":"TypeScript","funding_links":[],"categories":["Tools","Developer Resources","TypeScript"],"sub_categories":["Architecture","Tools"],"readme":"# Polar\n\n\u003e One-click Bitcoin Lightning networks for local app development \u0026 testing\n\n[![Actions Status](https://github.com/jamaljsr/polar/workflows/CI/badge.svg)](https://github.com/jamaljsr/polar/actions)\n[![codecov](https://codecov.io/gh/jamaljsr/polar/branch/master/graph/badge.svg)](https://codecov.io/gh/jamaljsr/polar)\n[![Crowdin](https://badges.crowdin.net/polar/localized.svg)](https://crowdin.com/project/polar)\n[![GitHub license](https://img.shields.io/github/license/jamaljsr/polar.svg)](https://github.com/jamaljsr/polar/blob/master/LICENSE)\n[![GitHub release](https://img.shields.io/github/release/jamaljsr/polar.svg)](https://GitHub.com/jamaljsr/polar/releases/)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/screen.png\" /\u003e\n  \u003ca href=\"https://youtu.be/mb37durvPns\" target=\"_blank\"\u003e\n    View a short video demo\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Purpose\n\nPolar was built to help Lightning Network application developers quickly spin up one or more networks locally on their computers.\n\nWith Polar you can:\n\n- Create a regtest Lightning Network in just a few clicks\n- Connect from your app to the lightning nodes via RPC\n- Add more nodes using drag \u0026 drop\n- Start and stop individual nodes\n- Open \u0026 Close Channels\n- Create \u0026 Pay Lightning Invoices\n- Launch a terminal in each bitcoin/lightning node\n- View streaming logs from each node\n- Manually mine new blocks\n- Deposit regtest coins into each Lightning node\n- Mint, Send \u0026 Receive Taproot Assets\n- Create \u0026 Pay Taproot Asset invoices\n- Export and import networks, for sharing with other Lightning developers\n- Create you own docker images to use as [custom nodes](https://github.com/jamaljsr/polar/blob/master/docs/custom-nodes.md) (ex: master branch, local fork)\n\nSupported Network Node Versions:\n\n- [LND](https://github.com/lightningnetwork/lnd) - v0.20.0, v0.19.3, v0.19.2, v0.19.1, v0.18.5, v0.18.4, v0.18.3, v0.17.5, v0.16.4\n- [Core Lightning](https://github.com/ElementsProject/lightning) - v25.12, v25.09.3, v25.05, v25.02, v24.11.1, v24.08.1\n- [Eclair](https://github.com/ACINQ/eclair/) - v0.13.1, v0.12.0, v0.11.0, v0.10.0, v0.9.0\n- [Bitcoin Core](https://github.com/bitcoin/bitcoin) - v30.0, v29.0, v28.0, v27.0, v26.0\n- [Taproot Assets](https://github.com/lightninglabs/taproot-assets) - v0.7.0, v0.6.1, v0.6.0, v0.5.1, v0.5.0, v0.4.1, v0.3.3\n- [Terminal](https://github.com/lightninglabs/lightning-terminal) - v0.16.0, v0.15.3, v0.15.1, v0.15.0, v0.14.1,\n\n### MCP (Model Context Protocol)\n\nPolar includes an MCP server that enables AI agents like Claude \u0026 Cursor to programmatically control Lightning Network simulations.\n\nSee the [polar-mcp](https://github.com/jamaljsr/polar-mcp) repo for installation instructions.\n\nSee the [MCP Architecture Documentation](docs/mcp-architecture.md) for technical information on the architecture, API, and how to add new tools to Polar.\n\n## Dependencies\n\nPolar requires that you have Docker installed to create the local networks\n\n- On Mac \u0026 Windows, you can just install [Docker Desktop](https://www.docker.com/products/docker-desktop)\n- On Linux, you need to install [Docker Server](https://docs.docker.com/engine/install/#server).\n\nYou will be prompted to install Docker if Polar cannot detect it automatically\n\n⚠️ **Important Docker Notes**\n\n- On Linux, Docker Desktop is currently not supported due to a significant change in how it handles file sharing between host and container (See [#636](https://github.com/jamaljsr/polar/issues/636#issuecomment-1450201391))\n\n## Download\n\nDownload Polar v4.0.0 for your OS\n\n- Mac ([dmg](https://github.com/jamaljsr/polar/releases/download/v4.0.0/polar-mac-x64-v4.0.0.dmg))\n- Linux ([deb](https://github.com/jamaljsr/polar/releases/download/v4.0.0/polar-linux-amd64-v4.0.0.deb), [AppImage](https://github.com/jamaljsr/polar/releases/download/v4.0.0/polar-linux-x86_64-v4.0.0.AppImage), [RPM](https://github.com/jamaljsr/polar/releases/download/v4.0.0/polar-linux-x86_64-v4.0.0.rpm))\n- Windows ([exe](https://github.com/jamaljsr/polar/releases/download/v4.0.0/polar-win-x64-v4.0.0.exe))\n\nAlternative and older version binaries can be found in the [GitHub releases](https://github.com/jamaljsr/polar/releases)\n\n## Help Translate\n\nPolar's translations are managed on [Crowdin](https://crowdin.com/project/polar). The initial translations of 10 languages were done by machine (Google Translate) and are likely to not be 100% accurate. If you speak multiple languages and wish to help with translations, please feel free to head over to the [project page](https://crowdin.com/project/polar) on Crowdin and submit updated strings. This assistance would be greatly appreciated.\n\n## Development\n\nIf you would like to learn how to package Polar from source code or want to fix a bug or add a new feature, please see [CONTRIBUTING](https://github.com/jamaljsr/polar/blob/master/CONTRIBUTING.md) for detailed instructions.\n\n### Commands\n\n| Command         | Description                                                       |\n| --------------- | ----------------------------------------------------------------- |\n| `yarn`          | install dependencies                                              |\n| `yarn dev`      | run the app with react hot reloading and electron live restarting |\n| `yarn test`     | run unit tests in watch mode                                      |\n| `yarn test:e2e` | run e2e tests                                                     |\n| `yarn lint:all` | run typescript and eslint syntax checking                         |\n| `yarn package`  | package the app for your OS                                       |\n\n### Tech Stack\n\n- [Node.js](https://nodejs.org/en): nodejs version \u003e= 20\n- [Electron](https://github.com/electron/electron/): cross platform desktop app framework\n- [Typescript](https://github.com/microsoft/TypeScript): increased productivity with a typed language\n- [ReactJS](https://github.com/facebook/react/): declarative UI library for JavaScript\n- [Create React App](https://github.com/facebook/create-react-app): minimize build configuration\n- [easy-peasy](https://github.com/ctrlplusb/easy-peasy): Redux state management without the boilerplate\n- [Emotion](https://emotion.sh/): simplified CSS style composition\n- [Ant Design](https://github.com/ant-design/ant-design/): don't reinvent the wheel with UI design\n- [react-i18next](https://github.com/i18next/react-i18next): support for multiple languages (english/spanish included)\n- [electron-log](https://github.com/megahertz/electron-log): multi-level logging to console and file\n- [Prettier](https://github.com/prettier/prettier): keep code format consistent\n- [ESLint](https://github.com/eslint/eslint): follow code quality best practices\n- [Github Actions](https://github.com/actions): automate builds and testing on Windows/Mac/Linux\n- [Renovate Bot](https://github.com/renovatebot/renovate): automate dependency upgrades via GitHub bot\n- [Jest](https://github.com/facebook/jest): delightful JavaScript testing\n- [React Testing Library](https://github.com/testing-library/react-testing-library): React specific testing utilities\n- [CodeCov](https://codecov.io/): maintain quality of unit tests\n- [Testcafe](https://github.com/DevExpress/testcafe): End-to-end is important\n- [commitlint](https://github.com/conventional-changelog/commitlint): standardize git commit messages\n- [standard-version](https://github.com/conventional-changelog/commitlint): automate release versioning and changelog generation\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamaljsr%2Fpolar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjamaljsr%2Fpolar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamaljsr%2Fpolar/lists"}