+
+
---
This template is a starter template for building an Algorand based dApp on React with [`subtopia-js-sdk`](https://github.com/subtopia-algo/subtopia-js) integration. The template is based on the official [`algokit-react-template`](https://github.com/algorandfoundation/algokit-react-frontend-template).
## Features
-The template offers two presets, the recommended preset includes all of the above, a custom preset allows you to select which features you want to include in your project.
+The template offers two presets, the recommended preset includes all of the features included in the official [algokit-react-frontend-template](https://github.com/algorandfoundation/algokit-react-frontend-template), a custom preset allows you to select which features you want to include in your project.
The full list of features includes the following:
diff --git a/template_content/README.md.jinja b/template_content/README.md.jinja
index 6cd5477..30a6553 100644
--- a/template_content/README.md.jinja
+++ b/template_content/README.md.jinja
@@ -1,6 +1,10 @@
# {{ project_name }}
-This starter React project has been generated using AlgoKit. See below for default getting started instructions.
+This starter Subtopia integrated dApp project has been generated using AlgoKit. See below for default getting started instructions.
+
+- For detailed documentation on Subtopia platform refer to [Subtopia documentation](https://docs.subtopia.io).
+- To learn more about Subtopia JavaScript SDK refer to [SDK documentation](https://docs.subtopia.io/integrations/javascript-sdk).
+- To see other more generic examples in Next.js, React, Vue.js and Svelte refer to [Subtopia examples](https://github.com/subtopia-algo/subtopia-js-examples)
# Setup
diff --git a/template_content/package.json.jinja b/template_content/package.json.jinja
index 5563845..db2af04 100644
--- a/template_content/package.json.jinja
+++ b/template_content/package.json.jinja
@@ -10,37 +10,37 @@
"node": ">=18.0"
},
"devDependencies": {
- "@types/node": "18.17.14",
- "@types/react": "18.2.11",
- "@types/react-dom": "18.2.4",
- "@vitejs/plugin-react-swc": "3.3.2",
- "autoprefixer": "10.4.14",
+ "@types/node": "^18.17.14",
+ "@types/react": "^18.2.11",
+ "@types/react-dom": "^18.2.4",
+ "@vitejs/plugin-react-swc": "^3.3.2",
+ "autoprefixer": "^10.4.14",
{% if use_eslint_prettier -%}
- "eslint": "8.42.0",
- "eslint-config-prettier": "8.8.0",
- "eslint-plugin-prettier": "5.0.0",
- "@typescript-eslint/eslint-plugin": "6.5.0",
- "@typescript-eslint/parser": "6.5.0",
+ "eslint": "^8.42.0",
+ "eslint-config-prettier": "^8.8.0",
+ "eslint-plugin-prettier": "^5.0.0",
+ "@typescript-eslint/eslint-plugin": "^6.5.0",
+ "@typescript-eslint/parser": "^6.5.0",
{% endif -%}
{% if use_tailwind -%}
"postcss": "^8.4.24",
- "tailwindcss": "3.3.2",
+ "tailwindcss": "^3.3.2",
{% endif -%}
{% if use_jest -%}
"ts-jest": "^29.1.1",
- "@types/jest": "29.5.2",
+ "@types/jest": "^29.5.2",
{% endif -%}
- "ts-node": "10.9.1",
- "typescript": "5.1.6",
+ "ts-node": "^10.9.1",
+ "typescript": "^5.1.6",
{% if use_playwright -%}
"@playwright/test": "^1.35.0",
"playwright": "^1.35.0",
{% endif -%}
- "vite": "4.4.9"
+ "vite": "^5.0.5"
},
"dependencies": {
"@walletconnect/modal-sign-html": "^2.6.1",
- "@algorandfoundation/algokit-utils": "^4.1.0",
+ "@algorandfoundation/algokit-utils": "^5.0.1",
"@blockshake/defly-connect": "^1.1.6",
"@daffiwallet/connect": "^1.0.3",
"@perawallet/connect": "^1.3.1",
@@ -51,7 +51,9 @@
{% endif -%}
"notistack": "^3.0.1",
"react": "^18.2.0",
- "react-dom": "18.2.0",
+ "react-dom": "^18.2.0",
+ "react-use": "^17.4.2",
+ "subtopia-js-sdk": "^1.0.0",
"tslib": "^2.6.2"
},
"scripts": {
diff --git a/template_content/src/App.tsx b/template_content/src/App.tsx
index 79657e2..a0fab1b 100644
--- a/template_content/src/App.tsx
+++ b/template_content/src/App.tsx
@@ -6,7 +6,7 @@ import algosdk from 'algosdk'
import { SnackbarProvider } from 'notistack'
import { useState } from 'react'
import ConnectWallet from './components/ConnectWallet'
-import Transact from './components/Transact'
+import Transact from './components/Demo'
import { getAlgodConfigFromViteEnvironment, getKmdConfigFromViteEnvironment } from './utils/network/getAlgoClientConfigs'
let providersArray: ProvidersArray
@@ -64,34 +64,34 @@ export default function App() {
return (
-
-
-
+
+
+
- Welcome to
AlgoKit 🙂
+ Welcome to
Subtopia.io
AlgoKit example
- This starter has been generated using official AlgoKit React template. Refer to the resource below for next steps.
+ This starter has been generated using Subtopia AlgoKit template. Refer to the resources below for next steps.
- This starter has been generated using official AlgoKit React template. Refer to the resource below for next steps.
+ This starter has been generated using Subtopia AlgoKit template. Refer to the resources below for next steps.