README.md

Fedimint UI Projects

Quick start

1. Install (Docker)[https://www.docker.com/]
2. From repo root run docker-compose up. This starts the Fedimint backend with two federation servers.
3. Open a new shell, and cd apps/gaurdian-ui. This folder is the setup UI for configuring a new federation.
4. Run REACT_APP_FM_CONFIG_API="ws://127.0.0.1:18174" yarn dev. This starts the UI connecting to the first federation server.
5. Run REACT_APP_FM_CONFIG_API="ws://127.0.0.1:18184" yarn dev. This starts the UI connecting to the second federation server.
6. To tear down, run docker-compose down

What's Inside

This project includes the following apps / packages:

Apps

• guardian-ui: Web app experience for setting up and administering fedimints. This is used by the Fedimint guardians
• gateway-ui: Web app experience for managing Fedimint gateways. This is used by Gateway administrators

Packages

• ui: Shared React UI component library for building Fedimint UI experiences
• eslint-config: Shared eslint configurations (includes eslint-plugin-react and eslint-config-prettier)
• tsconfig: Shared tsconfig.jsons used throughout Fedimint UI apps

Development

From root repo directory:

1. yarn install (First time only)
2. yarn build
3. You can run any of the following commands from repo root directory

• yarn test - Tests all apps and packages in the project
• yarn build - Build all apps and packages in the project
• yarn clean - Cleans previous build outputs from all apps and packages in the project
• yarn format - Fixes formatting in all apps and packages in the project

Alternatively, you can navigate to a specific app or package within fedimint-ui/ directory and run it's respective development commands

Using (mprocs)[https://github.com/pvolok/mprocs]

1. (Install mprocs)[https://github.com/pvolok/mprocs#installation]
2. Run mprocs -c mprocs.yml - This simulates the QuickStart start using mprocs

Adding more federation servers