Skip to content

bitcoinj-cash/lighthouse

Repository files navigation

Lighthouse

Lighthouse is a bitcoin cash compatible fork of Mike Hearn's Lighthouse project

It is a decentralised, peer to peer crowdfunding application that uses the smart contracts features of the Bitcoin protocol. It lets you create projects and pledge to those projects.

project status - WIP

Currently the project is a work in progress and not yet fully functional. It currently builds with a bit of tweaking and it is possible to create and complete projects using the client. Currently a fully funded project cannot be broadcast to the network as there is no lighthouse server running. We hope to have this service up and running ASAP.

This is project is now considered maintained again. However it was primarily updated as a proof of concept for it's main dependency bitcoinj.cash and as such no significant new development is currently planned beyond building a deploying a working lighthouse server and cleaning up the build process to make it seamless.

If you would like to contribute to the project please get in touch on the bitcoinj.cash mailing list

how to tweak the user interface

You can do some work on the UI without being a Java developer. If you have web design experience modifying the Lighthouse UI will seem quite familiar. Ask for a binary build if you don't want to compile the app yourself, and then run Lighthouse with the --resdir=/path/to/ui/files flag. It should point to the client/src/main/resources/lighthouse directory from this git repository. You can use the Shortcut+S key combination to reload the UI whilst the app is running. Shortcut is the Cmd key on a Mac and Control key on Windows/Linux. The UI is defined by the CSS files and FXML files (similar to HTML but different language).

Documentation:

You can also use the Scene Builder tool to do visual UI design. It can't load main.fxml but everything else should open just fine.

license and legal stuff

The Lighthouse code is under the Apache license, which allows for commercial derivatives.

However the Lighthouse logo and name are not open. In future the logo images and name may be taken out of this repository and put into a proprietary branch. This would be a similar arrangement to Firefox and Chrome. The purpose of this is to ensure that if someone downloads an app called "Lighthouse" they know what they are getting and that it is not, for example, a fork or patched version of the app that may be broken in some way. If someone were to distribute a fork of the app, they would have to create a new name and logo so users can tell the fork apart from the original.

Thus to avoid confusion if you'd like to distribute a version of the project that doesn't match the upstream sources, please invent a new name and logo for it first. Thanks.

building from source

Building Lighthouse from source requires the Maven build tool and the bitcoinj.cash library.

Compile Lighthouse with:

$ https://github.com/bitcoinj-cash/lighthouse
$ cd lighthouse
$ mvn clean package

This will pull the latest version of bitcoinj.cash as a dependency from the Maven central repo.

Alternatively the latest version of bitcoinj.cash can be installed from source:

$ git clone https://github.com/bitcoinj-cash/bitcoinj
$ cd bitcoinj-cash
$ mvn clean install

Run Lighthouse with:

$ java -jar client/target/shaded.jar

About

A bitcoin cash re-imagining of vinumeris/lighthouse

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published