/raspiblitz-web

A mobile-first responsive Web UI for the RaspiBlitz

Primary LanguageTypeScriptMIT LicenseMIT

Raspiblitz Web - a responsive Web UI for the RaspiBlitz

Raspiblitz Dashboard

In collaboration with Bitcoin Design.

Images of the WebUI can be found at raspiblitz-web-progress

Built with React & Tailwind CSS.

Translations

If you want to bring the Raspiblitz WebUI to other languages, please help us translate it via Weblate :)

Big thanks to our translators, which you can find in this README.

Development

Dependencies

Update npm dependencies

yarn upgrade-interactive

If you notice several versions of a dep in the yarn.lock-file:

yarn dedupe

Further info: https://dev.to/arcanis/yarn-2-2-dedupe-faster-lighter-ha5#dedupe-command

Dev install with external RaspiBlitz as Backend (macOS)

  • Make sure nvm is installed.
  • Run nvm install 16 or if already installed nvm use
  • Install yarn on a fresh nvm: npm install --global yarn
  • run yarn
  • copy .env.sample to .env (the .env file will be ignored by git)
  • change in .env the value of REACT_APP_BACKEND to your local raspiblitz - for example if your RaspiBlitz is running on local Ip 192.168.1.123 then change value to http://192.168.1.123:80
  • with yarn start it should now connect to your external raspiblitz

Dev workflow

Frontend

yarn install
yarn start

Backend

For the backend, there currently exist two options:

  • Using the provided Mock backend
    • Easy to setup, but limited data
  • Using blitz_api with Polar
    • Some changes needed for local development
    • Possibly more data (depending on your ln setup :) )
Mock backend

See backend-mock folder

Open another terminal

cd backend-mock
yarn install
yarn start

Then go to http://localhost:3000 and use the password password.

Blitz API

This guide uses Polar for easier development, but you can also use a real lightning node.

  • First, download Polar and get it to run.
    • Create at least one bitcoin and one lightning node.
  • Next, clone the blitz_api, install the dependencies.
    • In addition, you will need redis installed for blitz_api to work.
  • Create a .env file (see .env_sample in blitz_api) and copy the bitcoin and ln info into it.
    • Important: When definining shell_script_path you need to define a directory where a folder called config.scripts and a file called blitz.debug.sh reside in. Otherwise blitz_api may not work (used on the RaspiBlitz for logging)
  • Make the following change in blitz_api:
    • In main/app/main.py, change the prefix_format from /v{major} to /api/v{major}.

Now you can start the blitz_api and run yarn start in raspiblitz-web.

Please do not commit the above changes.

Linting

eslint and prettier will be used accoring to the create-react-app docs

Credits & Licenses

Icons

App logos