feat: use-inkathon dns frontend example (#56)

* wip minimal dns contract example using `use-inkathon` library * completes interaction with example dns contract using vanilla `use-inkathon` * cleanup dns frontend example to be copied to others * updates to latest global changes for the examples * revert to recent `main` branch version * add interaction demo video * add demo.gif * removes video and add gif to readme. * direct reference to repo file and makes it a bit smaller
use-ink · Feb 23, 2024 · 53213d8 · 53213d8
1 parent f19fcdc
commit 53213d8
Show file tree

Hide file tree

Showing 16 changed files with 1,375 additions and 0 deletions.
diff --git a/dns/frontend/.eslintrc.cjs b/dns/frontend/.eslintrc.cjs
@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}
diff --git a/dns/frontend/.gitignore b/dns/frontend/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/dns/frontend/README.md b/dns/frontend/README.md
@@ -0,0 +1,20 @@
+# ink! Frontend Example
+
+This is a vanilla [vite + typescript](https://vitejs.dev/) project to showcase the use of [`useinkathon`](https://github.com/scio-labs/use-inkathon).
+
+## Getting Started
+
+You can use the package manager of your choice to install the dependencies and start the project in development mode. We like `pnpm` right now. But this example should work with `npm` & `yarn` as well.
+
+```sh
+pnpm install
+pnpm dev
+```
+
+## Change the Code
+
+The actual interaction with the contract is all contained in the `./src/App.tsx` file. Every other file in the folder is only relevant for styling and bundling.
+
+## Demo
+
+<img src="demo.gif" width="600px" />
diff --git a/dns/frontend/demo.gif b/dns/frontend/demo.gif
diff --git a/dns/frontend/index.html b/dns/frontend/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>ink! Frontend Example</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
diff --git a/dns/frontend/package.json b/dns/frontend/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "dns-frontend-example",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@polkadot/util-crypto": "^12.6.2",
+    "@scio-labs/use-inkathon": "^0.6.3",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.48",
+    "@types/react-dom": "^18.2.18",
+    "@typescript-eslint/eslint-plugin": "^6.19.1",
+    "@typescript-eslint/parser": "^6.19.1",
+    "@vitejs/plugin-react-swc": "^3.5.0",
+    "autoprefixer": "^10.4.17",
+    "eslint": "^8.56.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.5",
+    "postcss": "^8.4.33",
+    "tailwindcss": "^3.4.1",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.12"
+  }
+}
diff --git a/dns/frontend/postcss.config.js b/dns/frontend/postcss.config.js
@@ -0,0 +1,6 @@
+export default {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}