Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 2.33 KB

README.md

File metadata and controls

81 lines (53 loc) · 2.33 KB
Raw

Aliased - A WebView-Based Web5 Mobile Wallet App

This is a WebView-based Web5 wallet app written using Vue.js.

Recommended IDE Setup

VSCode + Vue - Official plugin (and NOT Vetur, or Volar).

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc (a dependency in package.json) for type checking. In editors, we need Vue - Official plugin to make the TypeScript language service aware of .vue types.

Building and Running the App

Prerequisites:

  • npm

iOS:

  • Xcode

Android:

  • Android Studio
  • JDK (Java Development Kit) 21 (NOT 23)

Installing dependencies

  1. Clone the web5-js repo, web5-js repo will be used as a direct dependency for this repo.

  2. Clone this repo as a peer repo to web-js (i.e. both repo directories have the same parent directory).

  3. Under this root directory of the local aliased repo run:

    npm install --legacy-peer-deps

NOTE: the --legacy-peer-deps is to workaround a polyfill dependency issue

Compile and Hot-Reload for Development

esbuild is used for development in browsers taking advantage of speed of `esbuild' which allows dynamic reloading:

npm run dev

Type-Check, Compile and Minify for Production

Instead esbuild, rollup is used for production builds which then get bundled in the mobile platforms:

npm run build

Optional: You can also run npm run preview to launch the production build and view it in a browser. This can be useful for sanity checking differences between dev builds, if any.

Running as Mobile Apps

Once a production build is ready (after running npm run build), we can now bundle up build as a mobile app using capacitor:

For iOS:

  1. Generate the iOS xcode project:

    npx cap sync

    NOTE: this should be run every time you wish to deploy a new build to the phone or simulator.

  2. Launch the project workspace file:

    open ./ios/App/App.xcworkspace

  3. Click on the "play" button to launch the app.

For Android:

npx cap run android

Lint with ESLint

npm run lint