Lisk DEX: UI is a frontend user-interface for the Lisk DEX: Core blockchain application. The project is developed using the Next.js framework and uses WalletConnect as a remote signing protocol.
Below is an index of the repositories which relate to this repository for easy navigation:
Repository | Description | |
---|---|---|
Lisk DEX: Specs | The Lisk DEX blockchain specifications. | |
Lisk DEX: Core | The Lisk DEX blockchain application. | |
Lisk DEX: Service | The Lisk DEX blockchain middleware between Core and UI. | |
X | Lisk DEX: UI | The Lisk DEX blockchain user-interface. |
- Clone the repository and change into the application directory:
git clone https://github.com/LiskHQ/lisk-dex-ui.git
cd lisk-dex-ui
- Install Node Version Manager and the required version of Node.js:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
nvm install
- Create an
.env.local
file and set the application environment variables:
NEXT_PUBLIC_PROJECT_ID=1234567890 # wallet project id
NEXT_PUBLIC_RELAY_URL=wss://relay.walletconnect.com # wallet connect websocket url
NEXT_PUBLIC_TEST_NET=testnet # network name
NEXT_PUBLIC_LISK_SERVICE_URL=https://testnet-service.lisk.com # lisk service https url
NEXT_PUBLIC_DEX_SERVICE_URL=https://testnet-dex-service.lisk.com # lisk (dex) service https url
NEXT_PUBLIC_DEX_SERVICE_WS_URL=wss://testnet-dex-service.lisk.com # lisk (dex) service websocket url
- Install the node modules (using yarn):
npm i -g yarn
yarn install --frozen-lockfile
- Build the Next.js application:
yarn build
- Start the Next.js application:
yarn start
Once the application process has started, the user-interface can be accessed locally at: http://localhost:3000/.
To stop the application process, press the key combination:
CTRL+C
-
Install Docker with Docker compose.
-
Clone the repository and change into the application directory:
git clone https://github.com/LiskHQ/lisk-dex-ui.git
cd lisk-dex-ui
- Start the application container:
docker-compose up
Once the application container is started, the user-interface can be accessed locally at: http://localhost:3000/.
To stop the application container, press the key combination:
CTRL+C
Assuming the Next.js application is already built from source.
To run the tests, execute the following command:
yarn test
https://github.com/LiskHQ/lisk-dex-ui/graphs/contributors
Warning
The source code of Lisk DEX: UI is considered to be a pre-release beta version that is subject to missing or incomplete features, bugs, and potential security flaws, and is therefore not suitable for usage in a production environment such as the Lisk Mainnet.
By using the source code of Lisk DEX: UI, you acknowledge and agree that you have an adequate understanding of the risks associated with the use of the source code of Lisk DEX: UI and that it is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. To the fullest extent permitted by law, in no event shall the Lisk Foundation or other parties involved in the development of Lisk DEX: UI have any liability whatsoever to any person for any direct or indirect loss, liability, cost, claim, expense or damage of any kind, whether in contract or in tort, including negligence, or otherwise, arising out of or related to the use of all or part of the source code of Lisk DEX: UI.
Copyright 2016-2024 Lisk Foundation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.