@circlesland/frame-app
v0.0.8
Published
## How it works?
Downloads
9
Readme
Circles Frame App
How it works?
The web-host
|| electron-host
|| capacitor-host
apps will require the @circlesland/frame-app
as a dependency and build together the full production app. All the host specific APIs will be injected into the window
object.
All the shared logic & platform agnostic code will be here in the @circlesland/frame-app
. The main purpose of the host apps is to implement the native APIs (example use localStorage on web, UserDefaults on iOS and SharedPreferences on Android, etc).
All apps (web, electron, capacitor) will open the auth-provider
for authentication on the native web browser. After the use completes the auth process in the web browser, it will be redirected back to the app (web for the web version, open the mobile app for capacitor or open the desktop app for electron).
Getting Started
- Clone this repository locally
- Clone any host app locally - web-host, electron-host, capacitor-host
- Run
npm install
into the host app - Run
npm link
into the frame app - Run
npm link @circlesland/frame-app
into the host app - Run
npm run dev
(ornpm run dev:ios
) into the host app 🎉 - Clone auth-provider locally and run
npm install
&npm start
Resources
- https://github.com/codechips/svelte-typescript-setups/blob/master/svelte-webpack5-typescript/package.json
Web3Auth
- https://web3auth.io/docs/quick-start?lang=html&chain=eth&customAuthentication=no&whitelabel=no&customLogin=no#step-1
Electron
- https://www.electronjs.org/docs/latest/tutorial/launch-app-from-url-in-another-app#electron-forge
- https://dev.to/olyno/how-to-create-an-electron-application-with-vite-im
Capacitor
- https://capacitorjs.com/solution/svelte