Renovate Bot 59ed5dfc2d chore(deps): update dependency @testing-library/jest-dom to v4.2.2		5 years ago
.github	ci(github): don't run e2e tests as they fail intermittently	5 years ago
.vscode	test(designer): add more unit tests for updated components	5 years ago
assets	docs(readme): add screenshot and purpose to readme	5 years ago
docker	feat(lnd): add support for multiple versions of LND nodes	5 years ago
e2e	test(e2e): fix inconsistent e2e test failures on windows	5 years ago
electron	fix(dockerservice): fix docker-compose not being found in PATH env	5 years ago
public	chore(config): use nodemon to automatically reload electron	5 years ago
src	refactor(routing): update variable name for the /network route	5 years ago
tools	ci(github): add app packaging to the build process	5 years ago
.commitlintrc	chore(setup): initial app setup (#1)	5 years ago
.editorconfig	chore(setup): initial app setup (#1)	5 years ago
.electronbuildrc	build(electron): fix rpc.proto not being included in the packaged app	5 years ago
.eslintignore	chore(config): use nodemon to automatically reload electron	5 years ago
.eslintrc	chore(deps): update dependencies react-scripts eslint webpack (#14)	5 years ago
.gitattributes	chore(setup): initial app setup (#1)	5 years ago
.gitignore	feat(lnd): implement initial communication with lnd	5 years ago
.i18next-scanner.js	chore(setup): initial app setup (#1)	5 years ago
.lintstagedrc	test(e2e): update e2e test to use new emotion css selectors	5 years ago
.prettierrc	chore(setup): initial app setup (#1)	5 years ago
.renovaterc	chore(config): remove schedule from renovate config	5 years ago
.rescriptsrc.js	feat(styles): add dependency babel-plugin-emotion	5 years ago
.stylelintrc	feat(styles): add emotion dependency	5 years ago
.testcafe-electron-rc	chore(setup): initial app setup (#1)	5 years ago
.versionrc	chore(setup): initial app setup (#1)	5 years ago
LICENSE	chore(setup): initial app setup (#1)	5 years ago
README.md	docs(readme): add link to downloads in the readme	5 years ago
TODO.md	feat(docker): display docker & compose versions in footer	5 years ago
package.json	chore(deps): update dependency @testing-library/jest-dom to v4.2.2	5 years ago
tsconfig.json	feat(network): create an actual network based on user input	5 years ago
yarn.lock	chore(deps): update dependency @testing-library/jest-dom to v4.2.2	5 years ago

README.md

Polar

One-click Bitcoin Lightning networks for local app development & testing

View a short video demo

Purpose

Polar was built to help Lightning Network application developers quickly spin up one or more networks locally on their computers.

With Polar you can:

Create a regtest Lightning Network in just a few clicks
Connect from your app to the lightning nodes via RPC
Add more nodes using drag & drop
Open & Close Channels
Manually mine new blocks
Deposit regtest coins into each Lightning node

Supported Network Nodes:

LND v0.8.0 & v0.7.1
Bitcoin Core v0.18.1
c-lightning (coming soon)
eclair (coming soon)

Dependencies

Polar requires that you have Docker installed to create the local networks

On Mac & Windows, you can just install Docker Desktop
On Linux, you need to install Docker Server and Docker Compose separately

Download

The current pre-release downloads can be found in the GitHub releases

Development

Commands

Command	Description
`yarn`	install dependencies
`yarn dev`	run the app with react hot reloading and electron live restarting
`yarn test`	run unit tests in watch mode
`yarn test:e2e`	run e2e tests
`yarn lint:all`	run typescript and eslint syntax checking
`yarn langs`	extract i18n language keys from code
`yarn pacakge`	package the app for your OS

Note: there is currently a bug in electron v6 on Windows with Dark Mode enabled. Use yarn win instead of yarn dev to automatically disabled dark mode during development. See win-light.cmd for more details.

Tips

install the import-sorter Visual Studio Code extension for automatic import statement sorting

Tech Stack

Electron: cross platform desktop app framework
Typescript: increased productivity with a typed language
ReactJS: declarative UI library for JavaScript
Create React App: minimize build configuration
easy-peasy: Redux state management without the boilerplate
Ant Design: don't reinvent the wheel with UI design
react-i18next: support for multiple languages (english/spanish included)
electron-log: multi-level logging to console and file
Prettier: keep code format consistent
ESLint: follow code quality best practices
Github Actions: automate builds and testing on Windows/Mac/Linux
Renevate Bot: automate dependency upgrades via GitHub bot
Jest: delightful JavaScript testing
React Testing Library: React specific testing utilities
CodeCov: maintain quality of unit tests
Testcafe: End-to-end is important
commitlint: standardize git commit messages
standard-version: automate release versioning and changelog generation

Recognition

Huge thanks to maintainers of Lightning Joule, Zap Wallet, LND, Bitcoin Core, along with many others for the amazing apps & libraries that gave this project inspiration, ideas & sometimes even a little code 😊.