docs: Quick start counter guide example and documentation update: Vite (#372)

* feat: updated quick start counter guide example and documentation

* lint fix

* feat: added vercel config

* fix: nightly conflict

* fix: updated vite template according to new import structure

---------

Co-authored-by: Call Delegation <106365423+calldelegation@users.noreply.github.com>

Author: rishabhkeshan

docs/guides/docs/counter-dapp/building-a-frontend.mdx

@@ -35,24 +35,46 @@ To split our project's contract from frontend code, let's initialize our fronten
 cd ..
 ```
 
-Now, initialize a React project with TypeScript using [`Create React App`](https://create-react-app.dev/).
+Now, initialize a React project with TypeScript using [`Vite`](https://vitejs.dev/).
 
 <TestAction
-id="create-react-app"
+id="create-vite-project"
 action={{
   name: 'runCommand',
   commandFolder: 'guides-testing/fuel-project'
 }}
 />
 
 ```sh
-npx create-react-app frontend --template typescript
+npm create vite@latest frontend -- --template react-ts
 ```
 
 The output should be similar to this:
 
 ```sh
-Success! Created frontend at Fuel/fuel-project/frontend
+Scaffolding project in Fuel/fuel-project/frontend...
+
+Done. Now run:
+
+  cd frontend
+  npm install
+  npm run dev
+```
+
+### Installing
+
+Move into the `frontend` folder and install the dependencies by running:
+
+<TestAction
+id="install-basic-deps"
+action={{
+  name: 'runCommand',
+  commandFolder: 'guides-testing/fuel-project'
+}}
+/>
+
+```sh
+cd frontend && npm install
 ```
 
 You should now have two folders inside your `fuel-project` folder: `counter-contract` and `frontend`.
@@ -66,14 +88,6 @@ You should now have two folders inside your `fuel-project` folder: `counter-cont
 The `fuels` package includes all the main tools you need to interact with your Sway programs and the Fuel network.
 The `@fuel-wallet` packages include everything you need to interact with user wallets.
 
-### Installing
-
-Move into the `frontend` folder by running:
-
-```sh
-cd frontend
-```
-
 > `fuels` requires Node version {props.nodeVersion}.
 
 Install the following packages in your `frontend` folder:
@@ -144,41 +158,41 @@ Inside the `frontend/src` folder let's add code that interacts with our contract
 
 Because we'll be using `@fuels/react`, first we need to wrap our app with the `FuelProvider` component.
 
-Add the imports below to the top of your `frontend/src/index.tsx` file and setup a query client:
+Add the imports below to the top of your `frontend/src/main.tsx` file and setup a query client:
 
 <TestAction
 id="provider-import"
 action={{
   name: 'modifyFile',
-  filepath: 'guides-testing/fuel-project/frontend/src/index.tsx',
-  atLine: 6,
+  filepath: 'guides-testing/fuel-project/frontend/src/main.tsx',
+  atLine: 5,
 }}
 />
 
 <CodeImport
-  file="../../examples/counter-dapp/frontend/src/index.tsx"
+  file="../../examples/counter-dapp/frontend/src/main.tsx"
   lang="tsx"
-  lineStart="6"
-  lineEnd="13"
+  lineStart="5"
+  lineEnd="10"
 />
 
-Next, modify your `frontend/src/index.tsx` file to wrap the `App` component with the `FuelProvider` and `QueryClientProvider` components.
+Next, modify your `frontend/src/main.tsx` file to wrap the `App` component with the `FuelProvider` and `QueryClientProvider` components.
 
 <TestAction
 id="fuel-wallet-provider"
 action={{
   name: 'modifyFile',
-  filepath: 'guides-testing/fuel-project/frontend/src/index.tsx',
-  atLine: 19,
-  removeLines: [19],
+  filepath: 'guides-testing/fuel-project/frontend/src/main.tsx',
+  atLine: 11,
+  removeLines: [11,12,13,14,15],
 }}
 />
 
 <CodeImport
-  file="../../examples/counter-dapp/frontend/src/index.tsx"
+  file="../../examples/counter-dapp/frontend/src/main.tsx"
   lang="tsx"
-  lineStart="19"
-  lineEnd="27"
+  lineStart="11"
+  lineEnd="23"
 />
 
 Next, change the file `fuel-project/frontend/src/App.tsx` to:
@@ -217,24 +231,20 @@ Inside the `fuel-project/frontend` directory run:
 id="start-app"
 action={{
   name: 'runCommand',
-  preCommand: "pnpm pm2 start 'PORT=4000 BROWSER=none <COMMAND>' --name 'react-dapp' --cwd ./guides-testing/fuel-project/frontend"
+  preCommand: "pnpm pm2 start 'BROWSER=none <COMMAND>' --name 'react-dapp' --cwd ./guides-testing/fuel-project/frontend"
 }}
 />
 
 ```sh
-npm start
+npm run dev
 ```
 
 ```sh
-Compiled successfully!
-
-You can now view frontend in the browser.
-
-  Local:            http://localhost:3000
-  On Your Network:  http://192.168.4.48:3000
+  VITE v5.3.5  ready in 108 ms
 
-Note that the development build is not optimized.
-To create a production build, use npm run build.
+  ➜  Local:   http://localhost:5173/
+  ➜  Network: use --host to expose
+  ➜  press h + enter to show help
 ```
 
 Click the "Connect" button and select the wallet you have installed to connect your wallet.
@@ -281,7 +291,7 @@ action={{
 id="go-to-frontend"
 action={{
   name: 'goToUrl',
-  url: "http://localhost:4000"
+  url: "http://localhost:5173"
 }}
 />
 

docs/guides/examples/counter-dapp/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 },
+    ],
+  },
+}

docs/guides/examples/counter-dapp/frontend/.gitignore

@@ -1,23 +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.local
-.env.development.local
-.env.test.local
-.env.production.local
-
+# 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?

docs/guides/examples/counter-dapp/frontend/README.md

@@ -1,46 +1,30 @@
-# Getting Started with Create React App
+# React + TypeScript + Vite
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
 
-## Available Scripts
+Currently, two official plugins are available:
 
-In the project directory, you can run:
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
 
-### `npm start`
+## Expanding the ESLint configuration
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+- Configure the top-level `parserOptions` property like this:
 
-### `npm test`
+```js
+export default {
+  // other rules...
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'],
+    tsconfigRootDir: __dirname,
+  },
+}
+```
 
-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.
-
-### `npm run 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.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
+- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

docs/guides/examples/counter-dapp/frontend/fuels.config.ts

@@ -2,12 +2,12 @@ import { createConfig } from 'fuels';
 
 export default createConfig({
   contracts: [
-    '../counter-contract',
+        '../counter-contract',
   ],
   output: './src/sway-api',
 });
 
 /**
  * Check the docs:
- * https://fuellabs.github.io/fuels-ts/tooling/cli/fuels/config-file
+ * https://docs.fuel.network/docs/fuels-ts/fuels-cli/config-file/
  */

docs/guides/examples/counter-dapp/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>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>