mirror of
https://github.com/logos-blockchain/lez-programs.git
synced 2026-05-18 23:19:30 +00:00
chore(amm): add Logos Basecamp support
Provides the necessary instructions to run the AMM app inside Logos Basecamp. Closes #29
This commit is contained in:
parent
06a141ef6e
commit
83665bf4de
3
amm-ui/.gitignore
vendored
Normal file
3
amm-ui/.gitignore
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
result
|
||||
result-*
|
||||
modules/
|
||||
@ -12,7 +12,15 @@ This project requires Nix with experimental features enabled. If you haven't alr
|
||||
mkdir -p ~/.config/nix && echo "experimental-features = nix-command flakes" >> ~/.config/nix/nix.conf
|
||||
```
|
||||
|
||||
## Running the UI
|
||||
Install the Logos package manager CLI globally (one-time):
|
||||
|
||||
```bash
|
||||
nix profile install 'github:logos-co/logos-package-manager#cli'
|
||||
```
|
||||
|
||||
This makes `lgpm` available as a global command.
|
||||
|
||||
## Running the UI standalone
|
||||
|
||||
Start the UI with:
|
||||
|
||||
@ -20,7 +28,55 @@ Start the UI with:
|
||||
nix run .
|
||||
```
|
||||
|
||||
This builds and runs the application in development mode.
|
||||
This builds and runs the application in development mode. The Logos bridge is unavailable in standalone mode, but the UI layout and mock data are fully functional.
|
||||
|
||||
## Running inside Logos Basecamp
|
||||
|
||||
### 1. Build the LGX package
|
||||
|
||||
```bash
|
||||
# Development variant (requires nix store at runtime)
|
||||
nix build '.#lgx' --out-link result-lgx
|
||||
|
||||
# Portable variant (self-contained, works without nix)
|
||||
nix build '.#lgx-portable' --out-link result-lgx-portable
|
||||
```
|
||||
|
||||
### 2. Install into Basecamp
|
||||
|
||||
```bash
|
||||
# Launch Basecamp once to initialise its data directory, then quit
|
||||
nix run 'github:logos-co/logos-basecamp'
|
||||
|
||||
# Set the data directory path
|
||||
# macOS:
|
||||
BASECAMP_DIR="$HOME/Library/Application Support/Logos/LogosBasecampDev"
|
||||
# Linux:
|
||||
# BASECAMP_DIR="$HOME/.local/share/Logos/LogosBasecampDev"
|
||||
|
||||
# Install the UI plugin
|
||||
lgpm --ui-plugins-dir "$BASECAMP_DIR/plugins" \
|
||||
install --file result-lgx/*.lgx
|
||||
```
|
||||
|
||||
> **Note:** Use matching variants throughout — dev with dev, portable with portable. Mixing variants causes loading failures. The portable build uses the `LogosBasecamp` data directory instead of `LogosBasecampDev`.
|
||||
|
||||
### 3. Launch Basecamp
|
||||
|
||||
```bash
|
||||
nix run 'github:logos-co/logos-basecamp'
|
||||
```
|
||||
|
||||
This fetches, builds, and launches Basecamp in one step. The AMM UI appears as a new tab in the Basecamp sidebar.
|
||||
|
||||
### Installing via the Basecamp UI
|
||||
|
||||
Alternatively, use the built-in package manager:
|
||||
|
||||
1. Launch Basecamp
|
||||
2. Open Package Manager
|
||||
3. Select "Install from file"
|
||||
4. Choose the `.lgx` file from `result-lgx/`
|
||||
|
||||
## Updating Dependencies
|
||||
|
||||
@ -29,3 +85,18 @@ To update the pinned versions of dependencies in `flake.lock`:
|
||||
```bash
|
||||
nix flake update
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Stale QML cache after rebuild:**
|
||||
```bash
|
||||
QML_DISABLE_DISK_CACHE=1 nix run 'github:logos-co/logos-basecamp'
|
||||
```
|
||||
|
||||
**Reset Basecamp data directory:**
|
||||
```bash
|
||||
# macOS
|
||||
rm -rf ~/Library/Application\ Support/Logos/LogosBasecampDev
|
||||
# Linux
|
||||
rm -rf ~/.local/share/Logos/LogosBasecampDev
|
||||
```
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
description = "Logos QML UI Module — replace with your description";
|
||||
description = "Logos Swap — Decentralized, privacy preversed trading";
|
||||
|
||||
inputs = {
|
||||
logos-module-builder.url = "github:logos-co/logos-module-builder";
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user