Open source software (+hardware) project to create a prototype Lightning Network ATM
If you would like to contribute to the project, the following should help get you started:
The following is a list of requirements needed to contribute to this project.
Clone this git repository:
git clone git@github.com:samotari/bleskomat.gitChange into the app directory, install dependencies, build and run the app:
cd app
npm install
npm startIf you would like to have partial hot reload while developing, run the following command in a separate terminal window:
npm run build:dev:watchIf you make any modifications in app/renderer, the build process will trigger automatically and you can see your changes in the Electron app by reloading the app (e.g. CMD+R on Mac, CTRL+R on Windows and Linux).
This project uses electron-builder to build packages for various platforms.
To build a development app package for your current system:
npm run builder:devTo build an app package for production:
npm run builder:prodIf you want to target a different architecture (e.g for raspberry pi):
npm run builder:prod -- --armv7lThe build configurations are defined here.
This project is licensed under the GNU Affero General Public License v3 (AGPL-3.0).
The AGPL license differs from the other GNU licenses in that it was built for network software. You can distribute modified versions if you keep track of the changes and the date you made them. As per usual with GNU licenses, you must license derivatives under AGPL. It provides the same restrictions and freedoms as the GPLv3 but with an additional clause which makes it so that source code must be distributed along with web publication. Since web sites and services are never distributed in the traditional sense, the AGPL is the GPL of the web.