polar/README.md

# Polar

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

[![Actions Status](https://github.com/jamaljsr/polar/workflows/CI/badge.svg)](https://github.com/jamaljsr/polar/actions)
[![codecov](https://codecov.io/gh/jamaljsr/polar/branch/master/graph/badge.svg)](https://codecov.io/gh/jamaljsr/polar)

<p align="center">
  <img src="./assets/screen.png" />
  <a href="https://youtu.be/ynlmq_3LVeA" target="_blank">
  View a short video demo
  </a>
</p>

## 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](https://www.docker.com/products/docker-desktop)
- On Linux, you need to install [Docker Server](https://docs.docker.com/install/#server) and [Docker Compose](https://docs.docker.com/compose/install/) separately

## 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](tools/win-light.cmd) for more details.

### Tips

- install the [import-sorter](https://github.com/SoominHan/import-sorter) Visual Studio Code extension for automatic import statement sorting

### Tech Stack

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

## Recognition

Huge thanks to maintainers of [Lightning Joule](https://github.com/joule-labs/joule-extension), [Zap Wallet](https://github.com/LN-Zap/zap-desktop), [LND](https://github.com/lightningnetwork/lnd), [Bitcoin Core](https://github.com/bitcoin/bitcoin), along with many others for the amazing apps & libraries that gave this project inspiration, ideas & sometimes even a little code 😊.
docs(readme): add screenshot and purpose to readme 5 years ago			`# Polar`
chore(setup): initial app setup (#1) 5 years ago
			`> One-click Bitcoin Lightning networks for local app development & testing`

chore(icons): update logo icons and images 5 years ago			`[![Actions Status](https://github.com/jamaljsr/polar/workflows/CI/badge.svg)](https://github.com/jamaljsr/polar/actions)`
chore(branding): change name throughout the app to Polar 5 years ago			`[![codecov](https://codecov.io/gh/jamaljsr/polar/branch/master/graph/badge.svg)](https://codecov.io/gh/jamaljsr/polar)`
chore(setup): initial app setup (#1) 5 years ago
docs(readme): add screenshot and purpose to readme 5 years ago			`<p align="center">`
			`<img src="./assets/screen.png" />`
			`<a href="https://youtu.be/ynlmq_3LVeA" target="_blank">`
			`View a short video demo`
			`</a>`
			`</p>`

			`## 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`
chore(setup): initial app setup (#1) 5 years ago
docs(readme): add screenshot and purpose to readme 5 years ago			`Supported Network Nodes:`

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

			`## Dependencies`
chore(setup): initial app setup (#1) 5 years ago
chore(branding): change name throughout the app to Polar 5 years ago			`Polar requires that you have Docker installed to create the local networks`
chore(setup): initial app setup (#1) 5 years ago
			`- On Mac & Windows, you can just install [Docker Desktop](https://www.docker.com/products/docker-desktop)`
			`- On Linux, you need to install [Docker Server](https://docs.docker.com/install/#server) and [Docker Compose](https://docs.docker.com/compose/install/) separately`

docs(readme): add screenshot and purpose to readme 5 years ago			`## Development`

refactor(imports): sort import statements in all source files 5 years ago			`### Commands`
chore(setup): initial app setup (#1) 5 years ago
chore(config): use nodemon to automatically reload electron When developing on the main process code, electron needs to be restarted to see the changes. nodemon will watch for code changes and restart the electron process when files are saved 5 years ago			`\| 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](tools/win-light.cmd) for more details.`
chore(setup): initial app setup (#1) 5 years ago
refactor(imports): sort import statements in all source files 5 years ago			`### Tips`
chore(setup): initial app setup (#1) 5 years ago
refactor(imports): sort import statements in all source files 5 years ago			`- install the [import-sorter](https://github.com/SoominHan/import-sorter) Visual Studio Code extension for automatic import statement sorting`
chore(setup): initial app setup (#1) 5 years ago
			`### Tech Stack`

			`- [Electron](https://github.com/electron/electron/): cross platform desktop app framework`
			`- [Typescript](https://github.com/microsoft/TypeScript): increased productivity with a typed language`
			`- [ReactJS](https://github.com/facebook/react/): declarative UI library for JavaScript`
			`- [Create React App](https://github.com/facebook/create-react-app): minimize build configuration`
			`- [easy-peasy](https://github.com/ctrlplusb/easy-peasy): Redux state management without the boilerplate`
			`- [Ant Design](https://github.com/ant-design/ant-design/): don't reinvent the wheel with UI design`
			`- [react-i18next](https://github.com/i18next/react-i18next): support for multiple languages (english/spanish included)`
			`- [electron-log](https://github.com/megahertz/electron-log): multi-level logging to console and file`
			`- [Prettier](https://github.com/prettier/prettier): keep code format consistent`
			`- [ESLint](https://github.com/eslint/eslint): follow code quality best practices`
docs(readme): update links and add a lil kudos 5 years ago			`- [Github Actions](https://github.com/actions): automate builds and testing on Windows/Mac/Linux`
chore(setup): initial app setup (#1) 5 years ago			`- [Renevate Bot](https://github.com/renovatebot/renovate): automate dependency upgrades via GitHub bot`
			`- [Jest](https://github.com/facebook/jest): delightful JavaScript testing`
			`- [React Testing Library](https://github.com/testing-library/react-testing-library): React specific testing utilities`
			`- [CodeCov](https://codecov.io/): maintain quality of unit tests`
			`- [Testcafe](https://github.com/DevExpress/testcafe): End-to-end is important`
			`- [commitlint](https://github.com/conventional-changelog/commitlint): standardize git commit messages`
			`- [standard-version](https://github.com/conventional-changelog/commitlint): automate release versioning and changelog generation`
docs(readme): update links and add a lil kudos 5 years ago
			`## Recognition`

docs(readme): add screenshot and purpose to readme 5 years ago			`Huge thanks to maintainers of [Lightning Joule](https://github.com/joule-labs/joule-extension), [Zap Wallet](https://github.com/LN-Zap/zap-desktop), [LND](https://github.com/lightningnetwork/lnd), [Bitcoin Core](https://github.com/bitcoin/bitcoin), along with many others for the amazing apps & libraries that gave this project inspiration, ideas & sometimes even a little code 😊.`