the0developer / marble-defi Goto Github PK

An open-source interface for a CosmWasm decentralized exchange.

Run the app in dev mode locally.

npm run dev
# or
yarn dev

Access the app on http://localhost:3000/.

The app configuration, feature flags, etc., is located in the .env config file.

To configure the app, you will need to swap the demo example configuration set with your chain information and add your tokens and ibc assets information.

Swap our test chain info example with your configuration to suggest your chain for Keplr and allow the wallet to be used in the app. It expects to receive data in the ChainInfo format. Refer to Keplr documentation for more information.

Keplr's 'suggest chain' feature allows front-ends to add new Cosmos-SDK based blockchains that are not natively supported.

Use this env variable to update the chain info path. The app will dynamically load the configuration so that the path can point to a local file in /public or a url.

Local

NEXT_PUBLIC_CHAIN_INFO_URL=/chain_info.testnet.json

Url

NEXT_PUBLIC_CHAIN_INFO_URL=https://raw.githubusercontent.com/Wasmswap/asset-list-example/main/chain_info.json

You will need to provide a token list json file for the available assets. By default, the platform has example tokens based on the Juno Uni-1 testnet. Refer to the token list example for more information.

Similarly to NEXT_PUBLIC_CHAIN_INFO_URL variable, the config will be loaded dynamically.

Local

NEXT_PUBLIC_TOKEN_LIST_URL=/token_list.testnet.json

Url

NEXT_PUBLIC_TOKEN_LIST_URL=https://raw.githubusercontent.com/Wasmswap/asset-list-example/main/token_list.json

By default, the platform only renders the example IBC assets. To allow for interchain asset transfers you will need to provide your ibc tokens lists. Refer to the ibc asset configuration example for more information.

Similarly to NEXT_PUBLIC_CHAIN_INFO_URL & NEXT_PUBLIC_TOKEN_LIST_URL variables, the config will be loaded dynamically.

Local

NEXT_PUBLIC_IBC_ASSETS_URL=/ibc_assets.json

Url

NEXT_PUBLIC_IBC_ASSETS_URL=https://raw.githubusercontent.com/Wasmswap/asset-list-example/main/ibc_assets.json

By default, the app uses the Wasmswap name. To update the app name, go to the .env file and change the following variable:

NEXT_PUBLIC_SITE_TITLE=Wasmswap

That will change the site title and update the footer.

By default, the app renders demo mode warning to warn the users that the app runs in a demo/simulation mode. If you'd like to disable the demo mode, update this env variable:

NEXT_PUBLIC_TEST_MODE_DISABLED=false

Update this variable if you choose to run a different version.

NEXT_PUBLIC_APP_VERSION=1.0.0

We rcommend vector graphics for your project's logo and name. Go to /icons/Logo.tsx and swap our branded logo symbol with yours to update the app logo.

Go to /icons/LogoText.tsx and update the file accordingly to update the logo text.

To update the color palette, go to components/theme.ts and provide your custom values.

To swap the font, navigate to components/theme.ts and update the font family tokens. Don't forget to connect your fonts. Refer to styles/globals.scss for an example.

Update your project colors in the same file by updating the color tokens, and values for textColors, iconColors, backgroundColors, borderColors. It's important to keep color tokens in one space as we're planning on supporting dark & sepia modes in the future.

To update the styling for buttons go to components/Button.tsx and provide your custom styling for the variants we use.

To update the typography component configuration, go to components/Text.tsx and provide your custom styling for our variants.

This is a nextjs app; thus everything that a nextjs app supports for deployment technically is supported by wasmswap-interface. We would recommend looking into Vercel.

Raise the bar for Web 3.0 with us! We would love you to contribute. Submit your PR contributions and issues directly on this repo.

Wasmswap interface is licensed under Apache 2.0.