feat: lp dashboard setup (#1327)

* feat: generate new nx application

* feat: add env variables & render a headline

* feat: add netlify config

* feat: add cypress projectId and delete unused files

apps/liquidity-provision-dashboard-e2e/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["plugin:cypress/recommended", "../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/liquidity-provision-dashboard-e2e/cypress.config.js

@@ -0,0 +1,24 @@
+const { defineConfig } = require('cypress');
+
+module.exports = defineConfig({
+  projectId: 'et4snf',
+
+  e2e: {
+    baseUrl: 'http://localhost:4200',
+    fileServerFolder: '.',
+    fixturesFolder: false,
+    specPattern: './src/integration/*.ts',
+    excludeSpecPattern: '**/*.js',
+    modifyObstructiveCode: false,
+    supportFile: './src/support/index.ts',
+    video: true,
+    videoUploadOnPasses: false,
+    videosFolder:
+      '../../dist/cypress/apps/liquidity-provision-dashboard-e2e/videos',
+    screenshotsFolder:
+      '../../dist/cypress/apps/liquidity-provision-dashboard-e2e/screenshots',
+    chromeWebSecurity: false,
+    viewportWidth: 1440,
+    viewportHeight: 900,
+  },
+});

apps/liquidity-provision-dashboard-e2e/project.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/liquidity-provision-dashboard-e2e/src",
+  "projectType": "application",
+  "targets": {
+    "e2e": {
+      "executor": "@nrwl/cypress:cypress",
+      "options": {
+        "cypressConfig": "apps/liquidity-provision-dashboard-e2e/cypress.config.js",
+        "devServerTarget": "liquidity-provision-dashboard:serve"
+      },
+      "configurations": {
+        "production": {
+          "devServerTarget": "liquidity-provision-dashboard:serve:production"
+        }
+      }
+    },
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": [
+          "apps/liquidity-provision-dashboard-e2e/**/*.{js,ts}"
+        ]
+      }
+    }
+  },
+  "tags": [],
+  "implicitDependencies": ["liquidity-provision-dashboard"]
+}

apps/liquidity-provision-dashboard-e2e/src/integration/app.cy.ts

@@ -0,0 +1,10 @@
+import { getGreeting } from '../support/app.po';
+
+describe('liquidity-provision-dashboard', () => {
+  beforeEach(() => cy.visit('/'));
+
+  it('should display welcome message', () => {
+    // Function helper example, see `../support/app.po.ts` file
+    getGreeting().contains('Top liquidity opportunities');
+  });
+});

apps/liquidity-provision-dashboard-e2e/src/support/app.po.ts

@@ -0,0 +1 @@
+export const getGreeting = () => cy.get('h1');

apps/liquidity-provision-dashboard-e2e/src/support/commands.ts

@@ -0,0 +1,9 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************

apps/liquidity-provision-dashboard-e2e/src/support/index.ts

@@ -0,0 +1,19 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+import '@vegaprotocol/cypress';
+import 'cypress-real-events/support';
+// Import commands.js using ES2015 syntax:
+import './commands';

apps/liquidity-provision-dashboard-e2e/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "sourceMap": false,
+    "allowSyntheticDefaultImports": true,
+    "outDir": "../../dist/out-tsc",
+    "allowJs": true,
+    "types": ["cypress", "node", "cypress-real-events"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.js"]
+}

apps/liquidity-provision-dashboard/.babelrc

@@ -0,0 +1,11 @@
+{
+  "presets": [
+    [
+      "@nrwl/react/babel",
+      {
+        "runtime": "automatic"
+      }
+    ]
+  ],
+  "plugins": []
+}

apps/liquidity-provision-dashboard/.browserslistrc

@@ -0,0 +1,16 @@
+# This file is used by:
+# 1. autoprefixer to adjust CSS to support the below specified browsers
+# 2. babel preset-env to adjust included polyfills
+#
+# For additional information regarding the format and rule options, please see:
+# https://github.com/browserslist/browserslist#queries
+#
+# If you need to support different browsers in production, you may tweak the list below.
+
+last 1 Chrome version
+last 1 Firefox version
+last 2 Edge major versions
+last 2 Safari major version
+last 2 iOS major versions
+Firefox ESR
+not IE 9-11 # For IE 9-11 support, remove 'not'.

apps/liquidity-provision-dashboard/.env

@@ -0,0 +1,27 @@
+# React Environment Variables
+# https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#expanding-environment-variables-in-env
+
+# Netlify Environment Variables
+# https://www.netlify.com/docs/continuous-deployment/#environment-variables
+NX_VERSION=$npm_package_version
+NX_REPOSITORY_URL=$REPOSITORY_URL
+NX_BRANCH=$BRANCH
+NX_PULL_REQUEST=$PULL_REQUEST
+NX_HEAD=$HEAD
+NX_COMMIT_REF=$COMMIT_REF
+NX_CONTEXT=$CONTEXT
+NX_REVIEW_ID=$REVIEW_ID
+NX_INCOMING_HOOK_TITLE=$INCOMING_HOOK_TITLE
+NX_INCOMING_HOOK_URL=$INCOMING_HOOK_URL
+NX_INCOMING_HOOK_BODY=$INCOMING_HOOK_BODY
+NX_URL=$URL
+NX_DEPLOY_URL=$DEPLOY_URL
+NX_DEPLOY_PRIME_URL=$DEPLOY_PRIME_URL
+NX_VEGA_CONFIG_URL="https://static.vega.xyz/assets/testnet-network.json"
+NX_VEGA_ENV = 'TESTNET'
+NX_VEGA_URL="https://api.n11.testnet.vega.xyz/graphql"
+NX_VEGA_WALLET_URL=http://localhost:1789/api/v1
+NX_ETHEREUM_PROVIDER_URL=https://ropsten.infura.io/v3/4f846e79e13f44d1b51bbd7ed9edefb8
+NX_ETHERSCAN_URL=https://ropsten.etherscan.io
+NX_VEGA_NETWORKS={"MAINNET":"https://alpha.console.vega.xyz"}
+NX_VEGA_EXPLORER_URL=https://explorer.fairground.wtf

apps/liquidity-provision-dashboard/.env.capsule

@@ -0,0 +1,4 @@
+# App configuration variables
+NX_VEGA_URL=http://localhost:3028/query
+NX_VEGA_ENV=LOCAL
+NX_VEGA_REST=http://localhost:3029

apps/liquidity-provision-dashboard/.env.devnet

@@ -0,0 +1,9 @@
+# App configuration variables
+NX_VEGA_CONFIG_URL=https://static.vega.xyz/assets/devnet-network.json
+NX_VEGA_URL=https://api.n04.d.vega.xyz/graphql
+NX_VEGA_ENV=DEVNET
+NX_VEGA_REST=https://api.n04.d.vega.xyz
+NX_VEGA_NETWORKS={\"MAINNET\":\"https://alpha.console.vega.xyz\"}
+NX_ETHEREUM_PROVIDER_URL=https://ropsten.infura.io/v3/4f846e79e13f44d1b51bbd7ed9edefb8
+NX_ETHERSCAN_URL=https://ropsten.etherscan.io
+NX_VEGA_EXPLORER_URL=https://dev.explorer.vega.xyz

apps/liquidity-provision-dashboard/.env.mainnet

@@ -0,0 +1,9 @@
+# App configuration variables
+NX_VEGA_CONFIG_URL=https://static.vega.xyz/assets/mainnet-network.json
+NX_VEGA_URL=https://api.token.vega.xyz/query
+NX_VEGA_ENV=MAINNET
+NX_VEGA_REST=https://api.token.vega.xyz
+NX_VEGA_NETWORKS='{\"MAINNET\":\"https://alpha.console.vega.xyz\"}'
+NX_ETHEREUM_PROVIDER_URL=https://mainnet.infura.io/v3/4f846e79e13f44d1b51bbd7ed9edefb8
+NX_ETHERSCAN_URL=https://etherscan.io
+NX_VEGA_EXPLORER_URL=https://explorer.vega.xyz

apps/liquidity-provision-dashboard/.env.stagnet3

@@ -0,0 +1,8 @@
+# App configuration variables
+NX_VEGA_CONFIG_URL=https://static.vega.xyz/assets/stagnet3-network.json
+NX_VEGA_URL=https://api.n01.stagnet3.vega.xyz/graphql
+NX_VEGA_ENV=STAGNET3
+NX_VEGA_REST=https://api.n01.stagnet3.vega.xyz
+NX_ETHEREUM_PROVIDER_URL=https://ropsten.infura.io/v3/4f846e79e13f44d1b51bbd7ed9edefb8
+NX_ETHERSCAN_URL=https://ropsten.etherscan.io
+NX_VEGA_EXPLORER_URL=https://staging2.explorer.vega.xyz

apps/liquidity-provision-dashboard/.env.testnet

@@ -0,0 +1,9 @@
+# App configuration variables
+NX_VEGA_CONFIG_URL=https://static.vega.xyz/assets/testnet-network.json
+NX_VEGA_URL=https://api.n11.testnet.vega.xyz/graphql
+NX_VEGA_ENV=TESTNET
+NX_VEGA_REST=https://api.n11.testnet.vega.xyz
+NX_VEGA_NETWORKS='{\"MAINNET\":\"https://alpha.console.vega.xyz\"}'
+NX_ETHEREUM_PROVIDER_URL=https://ropsten.infura.io/v3/4f846e79e13f44d1b51bbd7ed9edefb8
+NX_ETHERSCAN_URL=https://ropsten.etherscan.io
+NX_VEGA_EXPLORER_URL=https://explorer.fairground.wtf

apps/liquidity-provision-dashboard/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["plugin:@nrwl/nx/react", "../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*", "__generated__", "__generated___"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/liquidity-provision-dashboard/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'liquidity-provision-dashboard',
+  preset: '../../jest.preset.js',
+  transform: {
+    '^(?!.*\\.(js|jsx|ts|tsx|css|json)$)': '@nrwl/react/plugins/jest',
+    '^.+\\.[tj]sx?$': ['babel-jest', { presets: ['@nrwl/next/babel'] }],
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../coverage/apps/liquidity-provision-dashboard',
+};

apps/liquidity-provision-dashboard/netlify.toml

@@ -0,0 +1,4 @@
+[[redirects]]
+  from = "/*"
+  to = "/index.html"
+  status = 200

apps/liquidity-provision-dashboard/postcss.config.js

@@ -0,0 +1,10 @@
+const { join } = require('path');
+
+module.exports = {
+  plugins: {
+    tailwindcss: {
+      config: join(__dirname, 'tailwind.config.js'),
+    },
+    autoprefixer: {},
+  },
+};

apps/liquidity-provision-dashboard/project.json

@@ -0,0 +1,84 @@
+{
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/liquidity-provision-dashboard/src",
+  "projectType": "application",
+  "targets": {
+    "build": {
+      "executor": "@nrwl/web:webpack",
+      "outputs": ["{options.outputPath}"],
+      "defaultConfiguration": "production",
+      "options": {
+        "compiler": "babel",
+        "outputPath": "dist/apps/liquidity-provision-dashboard",
+        "index": "apps/liquidity-provision-dashboard/src/index.html",
+        "baseHref": "/",
+        "main": "apps/liquidity-provision-dashboard/src/main.tsx",
+        "polyfills": "apps/liquidity-provision-dashboard/src/polyfills.ts",
+        "tsConfig": "apps/liquidity-provision-dashboard/tsconfig.app.json",
+        "assets": [
+          "apps/liquidity-provision-dashboard/src/favicon.ico",
+          "apps/liquidity-provision-dashboard/src/assets"
+        ],
+        "styles": ["apps/liquidity-provision-dashboard/src/styles.scss"],
+        "scripts": [],
+        "webpackConfig": "@nrwl/react/plugins/webpack"
+      },
+      "configurations": {
+        "development": {
+          "extractLicenses": false,
+          "optimization": false,
+          "sourceMap": true,
+          "vendorChunk": true
+        },
+        "production": {
+          "fileReplacements": [
+            {
+              "replace": "apps/liquidity-provision-dashboard/src/environments/environment.ts",
+              "with": "apps/liquidity-provision-dashboard/src/environments/environment.prod.ts"
+            }
+          ],
+          "optimization": true,
+          "outputHashing": "all",
+          "sourceMap": false,
+          "namedChunks": false,
+          "extractLicenses": true,
+          "vendorChunk": false
+        }
+      }
+    },
+    "serve": {
+      "executor": "./tools/executors/webpack:serve",
+      "options": {
+        "buildTarget": "liquidity-provision-dashboard:build",
+        "hmr": true
+      },
+      "configurations": {
+        "development": {
+          "buildTarget": "liquidity-provision-dashboard:build:development"
+        },
+        "production": {
+          "buildTarget": "liquidity-provision-dashboard:build:production",
+          "hmr": false
+        }
+      }
+    },
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": [
+          "apps/liquidity-provision-dashboard/**/*.{ts,tsx,js,jsx}"
+        ]
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/apps/liquidity-provision-dashboard"],
+      "options": {
+        "jestConfig": "apps/liquidity-provision-dashboard/jest.config.ts",
+        "passWithNoTests": true
+      }
+    }
+  },
+  "tags": []
+}

apps/liquidity-provision-dashboard/src/app/app.tsx

@@ -0,0 +1,11 @@
+import '../styles.scss';
+
+export function App() {
+  return (
+    <div className="flex items-stretch px-6 py-6">
+      <h1 className="text-3xl">Top liquidity opportunities</h1>
+    </div>
+  );
+}
+
+export default App;

apps/liquidity-provision-dashboard/src/environments/environment.prod.ts

@@ -0,0 +1,3 @@
+export const environment = {
+  production: true,
+};

apps/liquidity-provision-dashboard/src/environments/environment.ts

@@ -0,0 +1,6 @@
+// This file can be replaced during build by using the `fileReplacements` array.
+// When building for production, this file is replaced with `environment.prod.ts`.
+
+export const environment = {
+  production: false,
+};

apps/liquidity-provision-dashboard/src/index.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>Liquidity Provision Dashboard</title>
+    <base href="/" />
+
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="icon" type="image/x-icon" href="favicon.ico" />
+    <link
+      rel="preload"
+      href="https://static.vega.xyz/AlphaLyrae-Medium.woff2"
+      as="font"
+      type="font/woff2"
+      crossorigin="anonymous"
+    />
+
+    <link rel="stylesheet" href="https://static.vega.xyz/fonts.css" />
+  </head>
+  <body>
+    <div id="root" class="h-full max-h-full"></div>
+  </body>
+</html>

apps/liquidity-provision-dashboard/src/main.tsx

@@ -0,0 +1,13 @@
+import { StrictMode } from 'react';
+import { createRoot } from 'react-dom/client';
+
+import App from './app/app';
+
+const rootElement = document.getElementById('root');
+const root = rootElement && createRoot(rootElement);
+
+root?.render(
+  <StrictMode>
+    <App />
+  </StrictMode>
+);

apps/liquidity-provision-dashboard/src/polyfills.ts

@@ -0,0 +1,7 @@
+/**
+ * Polyfill stable language features. These imports will be optimized by `@babel/preset-env`.
+ *
+ * See: https://github.com/zloirock/core-js#babel
+ */
+import 'core-js/stable';
+import 'regenerator-runtime/runtime';

apps/liquidity-provision-dashboard/src/styles.scss

@@ -0,0 +1,8 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+html,
+body {
+  @apply h-full;
+}

apps/liquidity-provision-dashboard/tailwind.config.js

@@ -0,0 +1,16 @@
+const { join } = require('path');
+const { createGlobPatternsForDependencies } = require('@nrwl/next/tailwind');
+const theme = require('../../libs/tailwindcss-config/src/theme-lite');
+const vegaCustomClasses = require('../../libs/tailwindcss-config/src/vega-custom-classes');
+const vegaCustomClassesLite = require('../../libs/tailwindcss-config/src/vega-custom-classes-lite');
+
+module.exports = {
+  content: [
+    join(__dirname, 'src/**/*.{js,ts,jsx,tsx}'),
+    'libs/ui-toolkit/src/utils/shared.ts',
+    ...createGlobPatternsForDependencies(__dirname),
+  ],
+  darkMode: 'class',
+  theme,
+  plugins: [vegaCustomClasses, vegaCustomClassesLite],
+};

apps/liquidity-provision-dashboard/tsconfig.app.json

@@ -0,0 +1,23 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": ["node"]
+  },
+  "files": [
+    "../../node_modules/@nrwl/react/typings/cssmodule.d.ts",
+    "../../node_modules/@nrwl/react/typings/image.d.ts"
+  ],
+  "exclude": [
+    "jest.config.ts",
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.spec.tsx",
+    "**/*.test.tsx",
+    "**/*.spec.js",
+    "**/*.test.js",
+    "**/*.spec.jsx",
+    "**/*.test.jsx"
+  ],
+  "include": ["**/*.js", "**/*.jsx", "**/*.ts", "**/*.tsx"]
+}

apps/liquidity-provision-dashboard/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "allowJs": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.app.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

apps/liquidity-provision-dashboard/tsconfig.spec.json

@@ -0,0 +1,27 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node", "@testing-library/jest-dom"],
+    "jsx": "react",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true
+  },
+  "include": [
+    "jest.config.ts",
+    "**/*.test.ts",
+    "**/*.spec.ts",
+    "**/*.test.tsx",
+    "**/*.spec.tsx",
+    "**/*.test.js",
+    "**/*.spec.js",
+    "**/*.test.jsx",
+    "**/*.spec.jsx",
+    "**/*.d.ts"
+  ],
+  "files": [
+    "../../node_modules/@nrwl/react/typings/cssmodule.d.ts",
+    "../../node_modules/@nrwl/react/typings/image.d.ts"
+  ]
+}

workspace.json

@@ -15,6 +15,8 @@
     "fills": "libs/fills",
     "governance": "libs/governance",
     "liquidity": "libs/liquidity",
+    "liquidity-provision-dashboard": "apps/liquidity-provision-dashboard",
+    "liquidity-provision-dashboard-e2e": "apps/liquidity-provision-dashboard-e2e",
     "market-depth": "libs/market-depth",
     "market-info": "libs/market-info",
     "market-list": "libs/market-list",