Skip to content

Latest commit

 

History

History
96 lines (63 loc) · 5.66 KB

README.md

File metadata and controls

96 lines (63 loc) · 5.66 KB
Raw

Mars Protocol Osmosis Outpost Frontend

mars-banner-1200w

1. Web App

This project is a NextJS. React application.

The project utilises React hooks, functional components, Zustand for state management, and useQuery for general data fetching and management.

Typescript is added and utilised (but optional if you want to create .jsx or .tsx files).

SCSS with CSS modules (webpack allows importing css files into javascript, use the CSS module technique to avoid className clashes).

2. Deployment

Start web server

yarn && yarn dev

2.1 Custom node endpoints using non-Docker deployments

Copy .env.example to .env and modify the values to suit your needs.

2.2 Custom node endpoints using Docker

We allow the use of environment variables to be passed to the Docker container to specify custom endpoints for the app. The variables are:

Variable Description Default
URL_OSMOSIS_GQL The Osmosis Hive GraphQL endpoint to use https://osmosis.rpc.p2p.world/4dqst8e8Cgd2HMb2HDNkimP7NIkcbjuk/hive/graphql
URL_OSMOSIS_REST The Osmosis node REST endpoint to use https://lcd-osmosis.blockapsis.com
URL_OSMOSIS_RPC The Osmosis node RPC endpoint to use https://rpc-osmosis.blockapsis.com
URL_NEUTRON_GQL The Neutron Hive GraphQL endpoint to use https://neutron.rpc.p2p.world/qgrnU6PsQZA8F9S5Fb8Fn3tV3kXmMBl2M9bcc9jWLjQy8p/hive/graphql
URL_NEUTRON_REST The Neutron node REST endpoint to use https://rest-kralum.neutron-1.neutron.org
URL_NEUTRON_RPC The Neutron node RPC endpoint to use https://rpc-kralum.neutron-1.neutron.org
URL_NEUTRON_TEST_GQL The Neutron Testnet Hive GraphQL endpoint to use https://testnet-neutron-gql.marsprotocol.io/graphql
URL_NEUTRON_TEST_REST The Neutron Testnet node REST endpoint to use https://rest-palvus.pion-1.ntrn.tech
URL_NEUTRON_TEST_RPC The Neutron Testnet node RPC endpoint to use https://rpc-palvus.pion-1.ntrn.tech
WALLET_CONNECT_ID Your projecta WalletConnect v2 ID 0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x

Sample Docker run command

This command will start the container in interactive mode with port 3000 bound to localhost and print logs to stdout.

docker run -it -p 3000:3000 \
      -e URL_OSMOSIS_GQL=https://osmosis-node.marsprotocol.io/GGSFGSFGFG34/osmosis-hive-front/graphql \
      -e URL_OSMOSIS_REST=https://lcd-osmosis.blockapsis.com \
      -e URL_OSMOSIS_RPC=https://rpc-osmosis.blockapsis.com \
      -e URL_NEUTRON_GQL=https://neutron.rpc.p2p.world/qgrnU6PsQZA8F9S5Fb8Fn3tV3kXmMBl2M9bcc9jWLjQy8p/hive/graphql \
      -e URL_NEUTRON_REST=https://rest-kralum.neutron-1.neutron.org \
      -e URL_NEUTRON_RPC=https://rpc-kralum.neutron-1.neutron.org \
      -e URL_NEUTRON_TEST_GQL=https://testnet-neutron-gql.marsprotocol.io/graphql \
      -e URL_NEUTRON_TEST_REST=https://rest-palvus.pion-1.ntrn.tech \
      -e URL_NEUTRON_TEST_RPC=https://rpc-palvus.pion-1.ntrn.tech \
      -e WALLET_CONNECT_ID=0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x0x marsprotocol/interface:latest

3. Text and translations

This repository makes use of a translation repository. This repository containes all of the translation key values that are used within the UI. The rationale is to have no hardcoded display string values in this repository.

4. Development practices

4.1 Imports

Local components are imported via index files, which can be automatically generated with yarn index. This command targets index.ts files with a specific pattern in order to automate component exports. This results in clean imports throughout the pages:

import { Button, Card, Title } from 'components/common'

or

import { Breakdown, RepayInput } from 'components/fields'

In order for this to work, components are place in a folder with UpperCamelCase with the respective Component.tsx file. The component cannot be exported at default, so rather export the const instead.

4.2 Data orchestration

Data is handled with a combination of container components, useQuery and Zustand. Container components are responsible for syncing the application state with the wallet-provider state. This fire of the required queries in useQuery, which are for many cases also stored in Zustand.

We aim to have as much as possible available in Zustand, to have one source of truth.

5. Contributing

We welcome and encourage contributions! Please create a pull request with as much information about the work you did and what your motivation/intention was.

6. License

Contents of this repository are open source under the Mars Protocol Web Application License Agreement.