POAP Dashboard App (Milestones 1-4)

.env.example

@@ -0,0 +1,2 @@
+REACT_APP_URL_POAP_API="http://localhost:4000/"
+REACT_APP_KEY_XUMM_API=""

.gitignore

@@ -0,0 +1,24 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.prettierrc

@@ -0,0 +1,4 @@
+tabWidth: 2
+semi: true
+singleQuote: false
+printWidth: 80

README.md

@@ -1,2 +1,51 @@
-# POAP-APP
-The web app for Proof of Attendance Protocol 
+# POAP APP
+
+The web app for Proof of Attendance Protocol
+
+## Requirements
+- Node.js `v18.16.0+`
+- Yarn `v1.22.19+`
+- Running POAP API 2.0 server (backend), for details see [here](https://github.com/rikublock/POAP-API2)
+
+## Getting Started
+- Install dependencies with `yarn install`
+- Rename `.env.example` to `.env` (change values as needed)
+  - `REACT_APP_URL_POAP_API` (backend server URL)
+  - `REACT_APP_KEY_XUMM_API` (Xumm App API key, needs to match the key configured in the backend)
+- Ensure the backend service is running
+- Run the app with `yarn start`
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn install`
+
+Install dependencies.
+
+### `yarn start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `yarn test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `yarn build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+## Supported Wallets
+- Xumm (installation details [here](https://xumm.app/))
+- GemWallet (installation details [here](https://gemwallet.app/))

custom.d.ts

@@ -0,0 +1,11 @@
+declare module "*.svg" {
+  import * as React from "react";
+
+  const content: React.FunctionComponent<React.SVGAttributes<SVGElement>>;
+  export default content;
+}
+
+declare module "*.svg?url" {
+  const content: string;
+  export default content;
+}

package.json

@@ -0,0 +1,90 @@
+{
+  "name": "poap-app",
+  "version": "1.0.0",
+  "description": "Dashboard for the Proof of Attendance Protocol",
+  "author": "Riku Block",
+  "private": true,
+  "dependencies": {
+    "@ant-design/colors": "^7.0.0",
+    "@ant-design/icons": "^5.1.4",
+    "@emotion/react": "^11.11.0",
+    "@emotion/styled": "^11.11.0",
+    "@fortawesome/fontawesome-svg-core": "^6.4.2",
+    "@fortawesome/free-brands-svg-icons": "^6.4.2",
+    "@fortawesome/react-fontawesome": "^0.2.0",
+    "@gemwallet/api": "^3.4.0",
+    "@hookform/resolvers": "^3.1.1",
+    "@mui/icons-material": "^5.11.16",
+    "@mui/lab": "^5.0.0-alpha.134",
+    "@mui/material": "^5.13.2",
+    "@mui/x-data-grid": "^6.7.0",
+    "@mui/x-date-pickers": "^6.8.0",
+    "apexcharts": "^3.42.0",
+    "axios": "^1.4.0",
+    "date-fns": "^2.30.0",
+    "file-saver": "^2.0.5",
+    "jotai": "^2.1.0",
+    "notistack": "^3.0.1",
+    "qrcode.react": "^3.1.0",
+    "react": "^18.2.0",
+    "react-apexcharts": "^1.4.1",
+    "react-copy-to-clipboard": "^5.1.0",
+    "react-device-detect": "^2.2.3",
+    "react-dom": "^18.2.0",
+    "react-hook-form": "^7.45.0",
+    "react-jwt": "^1.2.0",
+    "react-router-dom": "^6.11.2",
+    "react-scripts": "5.0.1",
+    "react-window": "^1.8.9",
+    "web-vitals": "^2.1.0",
+    "xrpl": "^2.11.0",
+    "xumm": "^1.6.1",
+    "zod": "^3.21.4",
+    "zustand": "^4.3.8"
+  },
+  "scripts": {
+    "start": "webpack serve --mode development",
+    "build": "webpack --mode production"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "@svgr/webpack": "^8.1.0",
+    "@testing-library/jest-dom": "^5.14.1",
+    "@testing-library/react": "^13.0.0",
+    "@testing-library/user-event": "^13.2.1",
+    "@types/file-saver": "^2.0.5",
+    "@types/jest": "^27.0.1",
+    "@types/node": "^16.7.13",
+    "@types/react": "^18.0.0",
+    "@types/react-copy-to-clipboard": "^5.0.4",
+    "@types/react-dom": "^18.0.0",
+    "@types/react-window": "^1.8.5",
+    "dotenv-webpack": "^8.0.1",
+    "esbuild-loader": "^3.0.1",
+    "html-webpack-plugin": "^5.5.3",
+    "node-polyfill-webpack-plugin": "^2.0.1",
+    "ts-loader": "^9.4.3",
+    "tsconfig-paths-webpack-plugin": "^4.0.1",
+    "typescript": "^5.1.3",
+    "webpack": "^5.87.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^4.15.1"
+  }
+}

public/index.html

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Dashboard for the Proof of Attendance Protocol"
+    />
+    <title>POAP Dashboard</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

src/App.test.tsx

@@ -0,0 +1,7 @@
+import React from "react";
+import { render, screen } from "@testing-library/react";
+import App from "./App";
+
+test("nothing", () => {
+  render(<App />);
+});

src/App.tsx

@@ -0,0 +1,43 @@
+import { BrowserRouter } from "react-router-dom";
+import { Provider as JotaiProvider } from "jotai";
+import { SnackbarProvider } from "notistack";
+
+import { createTheme, ThemeProvider } from "@mui/material/styles";
+import { CssBaseline } from "@mui/material";
+import Slide from "@mui/material/Slide";
+import { LocalizationProvider } from "@mui/x-date-pickers/LocalizationProvider";
+import { AdapterDateFns } from "@mui/x-date-pickers/AdapterDateFns";
+
+import Routes from "routes";
+import { Web3Provider } from "connectors/context";
+import { AuthProvider } from "components/AuthContext";
+
+function App() {
+  const theme = createTheme();
+
+  return (
+    <BrowserRouter>
+      <JotaiProvider>
+        <Web3Provider>
+          <AuthProvider>
+            <ThemeProvider theme={theme}>
+              <SnackbarProvider
+                autoHideDuration={10000}
+                anchorOrigin={{ vertical: "top", horizontal: "right" }}
+                TransitionComponent={Slide}
+                maxSnack={3}
+              >
+                <LocalizationProvider dateAdapter={AdapterDateFns}>
+                  <CssBaseline />
+                  <Routes />
+                </LocalizationProvider>
+              </SnackbarProvider>
+            </ThemeProvider>
+          </AuthProvider>
+        </Web3Provider>
+      </JotaiProvider>
+    </BrowserRouter>
+  );
+}
+
+export default App;

src/apis/admin.ts

@@ -0,0 +1,27 @@
+import axios from "axios";
+import config from "config";
+
+import type { NetworkIdentifier, PlatformStats } from "types";
+
+export type getStatsParams = {
+  networkId: NetworkIdentifier;
+};
+
+export const getStats = async (
+  jwt: string,
+  params: getStatsParams
+): Promise<PlatformStats> => {
+  const response = await axios.get(
+    new URL("/admin/stats", config.apiURL).toString(),
+    {
+      headers: {
+        Authorization: `Bearer ${jwt}`,
+      },
+      responseType: "json",
+      timeout: config.timeout,
+      params: params,
+    }
+  );
+
+  return response.data.result as PlatformStats;
+};

src/apis/auth.ts

@@ -0,0 +1,72 @@
+import axios from "axios";
+import config from "config";
+
+import { WalletType } from "types";
+
+export const heartbeat = async (): Promise<boolean> => {
+  const response = await axios.get(
+    new URL("/auth/heartbeat", config.apiURL).toString(),
+    {
+      responseType: "json",
+      timeout: config.timeout,
+    }
+  );
+
+  return response.data.result as boolean;
+};
+
+export type nonceData = {
+  pubkey: string;
+};
+
+export const nonce = async (data: nonceData): Promise<string> => {
+  const response = await axios.post(
+    new URL("/auth/nonce", config.apiURL).toString(),
+    data,
+    {
+      responseType: "json",
+      timeout: config.timeout,
+    }
+  );
+
+  return response.data.result as string;
+};
+
+export type loginData = {
+  walletAddress: string;
+  walletType: WalletType;
+  data: string;
+  signature?: string;
+  claimFlow: boolean;
+};
+
+export const login = async (data: loginData): Promise<string> => {
+  const response = await axios.post(
+    new URL("/auth/login", config.apiURL).toString(),
+    data,
+    {
+      responseType: "json",
+      timeout: config.timeout,
+    }
+  );
+
+  return response.data.result as string;
+};
+
+export type refreshResult = string | null;
+
+export const refresh = async (jwt: string): Promise<refreshResult> => {
+  const response = await axios.post(
+    new URL("/auth/refresh", config.apiURL).toString(),
+    {},
+    {
+      headers: {
+        Authorization: `Bearer ${jwt}`,
+      },
+      responseType: "json",
+      timeout: config.timeout,
+    }
+  );
+
+  return response.data.result as refreshResult;
+};