Skip to content

Sats-Terminal/borrow-sdk-example

Repository files navigation

SatsTerminal UI registry example

This Next.js application demonstrates the production SatsTerminal Borrow UI registry. Its components are sourced from:

https://ui.satsterminal.com/r/{name}.json

The @satsterminal namespace is configured in components.json. There are no localhost or local-filesystem registry sources in this project.

Install the registry blocks

In a clean checkout or project, install every top-level block used by this example with:

npm run registry:install

To deliberately replace the checked-in component files with the current production versions, run:

npm run registry:sync

registry:sync passes the shadcn CLI's --overwrite flag, so review any local component customizations before running it.

This resolves the following production registry resources and their transitive dependencies:

npx shadcn@latest add \
  @satsterminal/loan-composer \
  @satsterminal/available-offers \
  @satsterminal/borrow-flow \
  @satsterminal/user-loans \
  @satsterminal/loan-management \
  @satsterminal/wallet-withdrawal

You can install a single block directly as well:

npx shadcn@latest add @satsterminal/wallet-withdrawal

Run the example

Create .env.local with your SDK API key:

NEXT_PUBLIC_SATSTERMINAL_API_KEY=your_api_key

Then install dependencies and start the application:

npm install
npm run dev

Open http://localhost:3000. This localhost address is only the example application's development server; registry resources still come from https://ui.satsterminal.com.

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors