hellobloom / bloom-starter Goto Github PK

I started following the instructions here: https://github.com/hellobloom/bloom-starter/tree/master/bloom-starter-react#geting-started

And immediately realized this wasn't going to work on Windows without modifications and I'll share what I did here. The long term solution is for us to make modifications or review/approve PRs that add support for windows. The curren problem is that this was built to support only mac/linux environments so there's path traversal and environment variable logic that's just not going to work on windows. That being said you can try this and it should work for you:

• Follows steps 1 & 2 of the Getting Started section as they should work (cd may require that you use windows \ paths)
• Step 3 will not work, but you can do the following as a workaround
  • npm install
  • cd client
  • npm install
    This worked for me to install all the required dependencies.
• Follow step 4
• Step 5 seemed to cause me the most troubles, but you should be able to do the following:
  • Build the server .\node_modules\.bin\tsc -p tsconfig.debug.json (I ran into an issue here where powershell wouldn't allow me to run script, so I opened powershell, actually I'm using Windows Terminal as an Administrator and ran Set-ExecutionPolicy RemoteSigned)
  • Run the server node --inspect=127.0.0.1:9300 build/index.js
  • In a new command line tab/window: The next step is to run ngrok and the client and that's done by start-dev command line that calls node bin/start-ngrok, but the workaround for windows is as follows:
    • Upgrade ngrok (the version installed didn't work for me on windows) npm update ngrok
    • In the start-ngrok.js file comment out the exec(... call and then run node bin/start-ngrok (be mindful of the pathing for windows). This should print out something like: starting ngrok ngrok url: https://eb258ecdbc4a.ngrok.io
    • Now copy that ngrok url and in a new command line tab/window run the following commands to set the environment vriables and run the client:
      • $env:REACT_APP_SERVER_URL="https://eb258ecdbc4a.ngrok.io"
      • $env:PORT="3006"
      • .\node_modules\.bin\react-scripts start

All of this worked for me and I was able to see a working client in my browser, open the Bloom app, and scan the QR code and see that my data was shared successfully. I'll add an issue to the bloom-starter repo containing this information.

npm run deps leads to this error:

[email protected] deps C:\Dariel\Development\African Bank\Self Soverign Identity\Code\bloom-starter-master\bloom-starter-react
./bin/deps

'.' is not recognized as an internal or external command,
operable program or batch file.

Integrate Bloom Share Kit into your live website or app such that an individual can create an account and sign in to an existing account using their BloomID and an attested email address. Submit your work as a pull request on the bloom-starter repo including a link to the website/app so that we can test to verify. The Bloom team will review the pull request for accuracy and may request up to two revisions. Submissions will be reviewed by the Bloom team and rewards will be issued when approved.

This bounty is worth 250 DAI and will be rewarded for any and all successful integrations into live apps!

You can find Share Kit here, Receive Kit for advanced integrations here, and an example set up in the Bloom Starter repo.