/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

npm update

Dev workflow

Frontend

npm install
npm run start

Backend

For the backend, there currently exist three options:

  • Use an existing RaspiBlitz
    • Easy to setup, but needs a RaspiBlitz
  • 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
npm install
npm run 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.

  • Download Polar and run it.
    • Create at least one bitcoin and one lightning node.
  • Clone the blitz_api and 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}.
  • Change the BACKEND_SERVER value in vite.config.ts to your local blitz_api installation.

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

Please do not commit the above changes.

Use a external RaspiBlitz as Backend

  • (Optional): Make sure nvm is installed.
  • (Optional): Run nvm install 20 or if already installed nvm use
  • Install the dependencies with npm install
  • Change the BACKEND_SERVER value in vite.config.ts to your local RaspiBlitz - for example if your RaspiBlitz is running on local IP 192.168.1.123 then change the value to http://192.168.1.123:80
  • with npm run start it should now connect to your external RaspiBlitz

Credits & Licenses

Icons

App logos