You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
jamaljsr 3e0989399e feat(electron): disable electron security warnings in dev environment 5 years ago
.github feat(styles): remove stylelint step in CI builds 5 years ago
.vscode feat(designer): remove the node card components and update unit tests 5 years ago
assets chore(icons): update logo icons and images 5 years ago
docker feat(bitcoind): add bitcoin-core dependency to project 5 years ago
e2e test(e2e): update e2e test to use new emotion css selectors 5 years ago
electron feat(electron): disable electron security warnings in dev environment 5 years ago
public chore(config): use nodemon to automatically reload electron 5 years ago
src chore(config): disable darkmode on windows to woraround electron v6 bug 5 years ago
tools chore(config): disable darkmode on windows to woraround electron v6 bug 5 years ago
.commitlintrc chore(setup): initial app setup (#1) 5 years ago
.editorconfig chore(setup): initial app setup (#1) 5 years ago
.electronbuildrc chore(branding): change name throughout the app to Polar 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(renovate): update 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 chore(config): use nodemon to automatically reload electron 5 years ago
TODO.md feat(bitcoind): support custom rpc port for bitcoind nodes 5 years ago
package.json feat(electron): persist app window size & location 5 years ago
tsconfig.json feat(network): create an actual network based on user input 5 years ago
yarn.lock feat(electron): persist app window size & location 5 years ago

README.md

Lightning Polar

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

Actions Status codecov

Development

Dependencies

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

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