Create build instructions

1fexd commented 1 year ago

Hello, first of all, thanks for building this awesome application, it has been really helpful!

May I suggest that you add detailed building instructions and maybe a Github Workflow/Action/CI and Github releases?

For example, while building (via make -f Makefile -C . build in the root directory), I noticed

go 1.19+ is required (Ubuntu Focal only ships 1.13)
protoc 3.15+ is required (Ubuntu Focal only ships 3.6.1)
Wails is required
The proto NPM script fails since the output directory src/proto does not exist by default (I had to manually create it)
After that the build failed with

github.com/bulwarkid/bulwark-passkey/app imports
    github.com/bulwarkid/bulwark-passkey/app/proto: module github.com/bulwarkid/bulwark-passkey@latest found (v0.0.0-20230408022719-3de2926d5cb5), but does not contain package github.com/bulwarkid/bulwark-passkey/app/proto

To fix this error
- I had to delete the empty folder external/protobuf-javascript and manually clone https://github.com/protocolbuffers/protobuf-javascript there (looks like something went wrong while setting this up as a git submodule?)
- After that, I had to install bazel, then run bazel build //generator:protoc-gen-js in external/protobuf-javascript
- Install protoc-gen-go (I did this via go install google.golang.org/protobuf/cmd/protoc-gen-go@latest in fear of the package in my apt repository being out of date again)
- I then was able to run make -f Makefile -C . all in proto/
After that I was finally able to successfully build the application.

Thanks!

camlafit commented 9 months ago

Hello

Do you thinks these explanations are useful #15 I've update some makefile and package.json to prevent missing directories

1fexd commented 2 months ago

Do you thinks these explanations are useful https://github.com/bulwarkid/bulwark-passkey/pull/15

Certainly looks interesting, although I'm not familiar with packaging applications as debian packages

camlafit commented 2 months ago

Hello

If we ignore specific deb building part, all other doc should be accurate to build any binary. Deb building is finally only a wrapper to provide binary provided by makefile.

I've don't work anymore on this issue, as I've bought a nitrokey between.

bulwarkid / bulwark-passkey

Create build instructions #7