jamaljsr
e617e33416
|
5 years ago | |
|---|---|---|
| .github | 5 years ago | |
| .vscode | 5 years ago | |
| assets | 5 years ago | |
| docker | 5 years ago | |
| e2e | 5 years ago | |
| electron | 5 years ago | |
| public | 5 years ago | |
| src | 5 years ago | |
| .commitlintrc | 5 years ago | |
| .crowdin.yml | 5 years ago | |
| .editorconfig | 5 years ago | |
| .electronbuildrc | 5 years ago | |
| .eslintignore | 5 years ago | |
| .eslintrc | 5 years ago | |
| .gitattributes | 5 years ago | |
| .gitignore | 5 years ago | |
| .i18next-scanner.js | 5 years ago | |
| .lintstagedrc | 5 years ago | |
| .prettierignore | 5 years ago | |
| .prettierrc | 5 years ago | |
| .renovaterc | 5 years ago | |
| .rescriptsrc.js | 5 years ago | |
| .stylelintrc | 5 years ago | |
| .testcafe-electron-rc | 5 years ago | |
| .versionrc | 5 years ago | |
| CHANGELOG.md | 5 years ago | |
| CONTRIBUTING.md | 5 years ago | |
| LICENSE | 5 years ago | |
| README.md | 5 years ago | |
| RELEASE.md | 5 years ago | |
| TODO.md | 5 years ago | |
| package.json | 5 years ago | |
| tsconfig.json | 5 years ago | |
| yarn.lock | 5 years ago | |
README.md
Polar
One-click Bitcoin Lightning networks for local app development & testing
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
- Start and stop individual nodes
- Open & Close Channels
- Create & Pay Lightning Invoices
- Launch a terminal in each bitcoin/lightning node
- Manually mine new blocks
- Deposit regtest coins into each Lightning node
Supported Network Node Versions:
- LND v0.8.2, v0.8.0 & v0.7.1
- Bitcoin Core v0.19.0.1 & v0.18.1
- c-lightning v0.8.1 & v0.8.0
- eclair (coming soon?) *need to gauge demand for this implementation*
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
You will be prompted to install Docker if Polar cannot detect it automatically
Download
Download Polar v0.2.1 for
Alternative and older version binaries can be found in the GitHub releases
Polar's Future
The overall goal of Polar is to minimize the time & effort needed for a developer new to Lightning to get started building their next killer app. In addition, Polar aims to be a useful tool for experienced Lightning App developers to iterate faster on their projects. Less time setting up nodes, more time building your app.
Here's a short list of ideas for features that may be beneficial to add in future releases (in no particular order):
- Network snapshots with the ability to import/export them. These could also be used as templates to quickly boot up a network with predefined nodes and channels. The templates could be hosted github to allow community contributions. This may require a scripting system built-in.
- Sample app projects/code in different languages (Python, Typescript/JS, Go, C#) showing how to connect to the Lightning/Bitcoin nodes from an external app.
- Bitcoin Block Explorer & GRPC/REST API Explorers to have access to all of the node RPC API's graphically, without needing to fallback to the Terminal.
Help Translate
Polar's translations are managed on Crowdin. 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 on Crowdin and submit updated strings. This assistance would be greatly appreciated.
Development
If 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 for detailed instructions.
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 package |
package the app for your OS |
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
- Emotion: simplified CSS style composition
- 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
- Renovate 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 😊.
Contact
The best place to reach me is on Twitter @jamaljsr. I also lurk in the LND Slack server, so you can msg me there as well.