mirror of https://github.com/lukechilds/polar.git
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.
|
6 years ago | |
---|---|---|
.github | 6 years ago | |
.vscode | 6 years ago | |
assets | 6 years ago | |
e2e | 6 years ago | |
electron | 6 years ago | |
public | 6 years ago | |
src | 6 years ago | |
.commitlintrc | 6 years ago | |
.editorconfig | 6 years ago | |
.electronbuildrc | 6 years ago | |
.eslintignore | 6 years ago | |
.eslintrc | 6 years ago | |
.gitattributes | 6 years ago | |
.gitignore | 6 years ago | |
.i18next-scanner.js | 6 years ago | |
.lintstagedrc | 6 years ago | |
.prettierrc | 6 years ago | |
.renovaterc | 6 years ago | |
.rescriptsrc.js | 6 years ago | |
.stylelintrc | 6 years ago | |
.testcafe-electron-rc | 6 years ago | |
.travis.yml | 6 years ago | |
.versionrc | 6 years ago | |
LICENSE | 6 years ago | |
README.md | 6 years ago | |
TODO.md | 6 years ago | |
appveyor.yml | 6 years ago | |
package.json | 6 years ago | |
tsconfig.json | 6 years ago | |
yarn.lock | 6 years ago |
README.md
Lightning Ditto
One-click Bitcoin Lightning networks for local app development & testing
Development
Dependencies
Ditto 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
Run the app
yarn && yarn dev
Run Unit Tests
yarn test
Run End-to-end Tests
yarn test:e2e
Run Typescript & Linter
yarn lint:all
Package App for your OS
yarn package
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
- Travis: automate builds and testing on Mac/Linux
- AppVeyor: automate builds and testing on Windows
- 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