Merge pull request #145 from secretkeylabs/edu/migrate-to-vite

Migrate to vite
secretkeylabs · Jul 9, 2024 · 06e363d · 06e363d
2 parents f34ca7e + 0823849
commit 06e363d
Show file tree

Hide file tree

Showing 31 changed files with 3,856 additions and 16,682 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -60,4 +60,4 @@ body:
 
         Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
     validations:
-      required: false
+      required: false
diff --git a/README.md b/README.md
@@ -62,6 +62,7 @@ For full documentation, visit [docs.xverse.app](https://docs.xverse.app/sats-con
 ```bash
 npm run build
 ```
+
 ### Run example app
 
 ```bash

diff --git a/example/.eslintrc.cjs b/example/.eslintrc.cjs
@@ -0,0 +1,29 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended-type-checked',
+    'plugin:@typescript-eslint/stylistic-type-checked',
+    'plugin:react-hooks/recommended',
+    'plugin:react/recommended',
+    'plugin:react/jsx-runtime',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.app.json', './tsconfig.node.json'],
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': ['warn', { allowConstantExport: true }],
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+};
diff --git a/example/README.md b/example/README.md
@@ -1,23 +1,27 @@
-Using sats-connect and Xverse to build a dapp
-=============================================
+# Using sats-connect and Xverse to build a dapp
+
 This is a simple example of how to use the sats-connect library to build a dapp. The dapp is a simple web application that allows users to send and receive btc and stx using the sats-connect library.
 
 The dapp is built in typescript with Create-React-App.
 
 # Installation and running the dapp
+
 To install the node dependencies for the dapp, run the following command:
+
 ```bash
 npm i
 ```
 
 To run the dapp, run the following command:
+
 ```bash
 npm start
 ```
 
 The dapp should now be reachable in your browser on http://localhost:3001
 
 # Using sats-connect
+
 [Sats-connect](https://github.com/secretkeylabs/sats-connect) is an open source library which allows you to interact with the Xverse wallet from your dapp. The library exposes a `request` function which you can use to send requests to the Xverse wallet. The `request` function takes a `method` and `params` as arguments. The `method` is the name of the method you want to call in the Xverse wallet and the `params` is an object with the parameters typed specifically for the method.
 
 If using typescript, the methods are typed and will come up in the intellisense of your IDE. Once you have typed a specific method, the params will be typed according to that method and will also come up in the intellisense.

diff --git a/example/public/index.html → example/index.html b/example/public/index.html → example/index.html
@@ -1,14 +1,15 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8" />
-    <link rel="icon" href="%PUBLIC_URL%/logo.png" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta charset="UTF-8" />
+    <link rel="icon" href="/logo.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta name="theme-color" content="#000000" />
     <title>Xverse dapp template</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>
     <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
   </body>
 </html>
-Original file line number
+Diff line change
@@ Expand Up @@
     ```bash
     npm run build
     ```
     ### Run example app
     ```bash
@@ Expand Down @@