stacks 0.51.0 → 0.52.0

package/core/utils/src/is.ts

@@ -1,14 +1,83 @@
-import { toString } from './base'
+import { getTypeName, toString } from './base'
 
-export const isDef = <T = any>(val?: T): val is T => typeof val !== 'undefined'
-export const isBoolean = (val: any): val is boolean => typeof val === 'boolean'
-export const isFunction = <T extends Function> (val: any): val is T => typeof val === 'function'
-export const isNumber = (val: any): val is number => typeof val === 'number'
-export const isString = (val: unknown): val is string => typeof val === 'string'
-export const isObject = (val: any): val is object => toString(val) === '[object Object]'
-export const isWindow = (val: any): boolean => typeof window !== 'undefined' && toString(val) === '[object Window]'
+export function isDef<T = any>(val?: T): val is T {
+  return typeof val !== 'undefined'
+}
+export function isBoolean(val: any): val is boolean {
+  return typeof val === 'boolean'
+}
+export function isFunction<T extends Function>(val: any): val is T {
+  return typeof val === 'function'
+}
+export function isNumber(val: any): val is number {
+  return typeof val === 'number'
+}
+export function isString(val: unknown): val is string {
+  return typeof val === 'string'
+}
+export function isObject(val: any): val is object {
+  return toString(val) === '[object Object]'
+}
+export function isWindow(val: any): boolean {
+  return typeof window !== 'undefined' && toString(val) === '[object Window]'
+}
 export const isBrowser = typeof window !== 'undefined'
 export const isServer = typeof document === 'undefined' // https://remix.run/docs/en/v1/pages/gotchas#typeof-window-checks
-export const isMap = (val: any): val is Map<any, any> => toString(val) === '[object Map]'
-export const isSet = (val: any): val is Set<any> => toString(val) === '[object Set]'
-export const isPromise = <T = any>(val: any): val is Promise<T> => isObject(val) && isFunction(val.then) && isFunction(val.catch)
+export function isMap(val: any): val is Map<any, any> {
+  return toString(val) === '[object Map]'
+}
+export function isSet(val: any): val is Set<any> {
+  return toString(val) === '[object Set]'
+}
+export function isPromise<T = any>(val: any): val is Promise<T> {
+  return toString(val) === '[object Promise]'
+}
+export function isUndefined(v: any) {
+  return getTypeName(v) === 'undefined'
+}
+export function isNull(v: any) {
+  return getTypeName(v) === 'null'
+}
+export function isSymbol(v: any) {
+  return getTypeName(v) === 'symbol'
+}
+export function isDate(v: any) {
+  return getTypeName(v) === 'date'
+}
+export function isRegExp(v: any) {
+  return getTypeName(v) === 'regexp'
+}
+export function isArray(v: any) {
+  return getTypeName(v) === 'array'
+}
+export function isPrimitive(v: any) {
+  const type = getTypeName(v)
+  return type === 'null' || type === 'undefined' || type === 'string' || type === 'number' || type === 'boolean' || type === 'symbol'
+}
+export function isInteger(v: any) {
+  return isNumber(v) && Number.isInteger(v)
+}
+export function isFloat(v: any) {
+  return isNumber(v) && !Number.isInteger(v)
+}
+export function isPositive(v: any) {
+  return isNumber(v) && v > 0
+}
+export function isNegative(v: any) {
+  return isNumber(v) && v < 0
+}
+export function isEven(v: any) {
+  return isNumber(v) && v % 2 === 0
+}
+export function isOdd(v: any) {
+  return isNumber(v) && v % 2 !== 0
+}
+export function isEvenOrOdd(v: any) {
+  return isNumber(v) && (v % 2 === 0 ? 'even' : 'odd')
+}
+export function isPositiveOrNegative(v: any) {
+  return isNumber(v) && (v > 0 ? 'positive' : 'negative')
+}
+export function isIntegerOrFloat(v: any) {
+  return isNumber(v) && (Number.isInteger(v) ? 'integer' : 'float')
+}

package/core/utils/src/promise.ts

@@ -1,5 +1,5 @@
-import { remove } from '@stacksjs/arrays'
 import type { Fn } from '@stacksjs/types'
+import { remove } from '@stacksjs/arrays'
 
 export interface SingletonPromiseReturn<T> {
   (): Promise<T>

package/core/utils/src/throttle.ts

@@ -0,0 +1,45 @@
+/**
+ * Throttle a function.
+ *
+ * @param fn
+ * @param wait
+ * @returns
+ *
+ * @example
+ * ```ts
+ * // logs window dimensions at most every 250ms
+ * window.addEventListener(
+ *   "resize",
+ *   throttle(function (evt) {
+ *     console.log(window.innerWidth)
+ *     console.log(window.innerHeight)
+ *   }, 250)
+ * )
+ */
+export function throttle(fn: Function, wait = 300) {
+  let inThrottle: boolean
+  let lastFn: ReturnType<typeof setTimeout>
+  let lastTime: number
+
+  return function (this: any) {
+    const context = this
+    const args = arguments
+
+    if (!inThrottle) {
+      fn.apply(context, args)
+
+      lastTime = Date.now()
+      inThrottle = true
+    }
+    else {
+      clearTimeout(lastFn)
+
+      lastFn = setTimeout(() => {
+        if (Date.now() - lastTime >= wait) {
+          fn.apply(context, args)
+          lastTime = Date.now()
+        }
+      }, Math.max(wait - (Date.now() - lastTime), 0))
+    }
+  }
+}

package/core/validation/README.md

@@ -32,7 +32,7 @@ pnpm test
 
 Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
 
-## 💪🏼 Contributing
+## 🚜 Contributing
 
 Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
 

package/core/validation/build.config.ts

@@ -0,0 +1,13 @@
+import { defineBuildConfig } from 'unbuild'
+
+export default defineBuildConfig({
+  entries: [
+    {
+      builder: 'mkdist',
+      input: './src/',
+      outDir: './dist/',
+    },
+  ],
+
+  declaration: true,
+})

package/core/validation/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/validation",
   "type": "module",
-  "version": "0.51.0",
-  "packageManager": "pnpm@7.26.3",
+  "version": "0.52.0",
+  "packageManager": "pnpm@8.5.1",
   "description": "The Stacks Validation methods.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -23,7 +23,12 @@
     "functions",
     "stacks"
   ],
-  "main": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "contributors": [
@@ -33,23 +38,17 @@
     "dist",
     "README.md"
   ],
-  "engines": {
-    "node": ">=v18.14.0",
-    "pnpm": ">=7.26.3"
-  },
   "scripts": {
-    "build": "mkdist -d",
-    "dev": "mkdist -d",
+    "build": "unbuild",
+    "dev": "unbuild --stub",
     "prepublishOnly": "pnpm run build",
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
-    "zod": "^3.20.2"
+    "zod": "^3.21.4"
   },
   "devDependencies": {
-    "@stacksjs/path": "workspace:*",
-    "@stacksjs/testing": "workspace:*",
-    "mkdist": "^1.1.0",
-    "typescript": "^4.9.5"
+    "@stacksjs/development": "workspace:*",
+    "@stacksjs/path": "workspace:*"
   }
 }

package/core/validation/src/index.ts

@@ -1,3 +1,29 @@
 import { z as validate, z } from 'zod'
 
+export const envVariables = validate.object({
+  APP_NAME: validate.string().default('Stacks').optional(),
+  APP_ENV: validate.string().default('local').optional(),
+  APP_KEY: validate.string(),
+  APP_URL: validate.string().url().default('http://localhost:3333'),
+  APP_DEBUG: validate.boolean().default(true),
+  DB_CONNECTION: validate.string().default('mysql').optional(),
+  DB_DATABASE: validate.string().default('stacks').optional(),
+  DB_USERNAME: validate.string().default('root').optional(),
+  DB_PASSWORD: validate.string().optional(),
+  SEARCH_ENGINE_DRIVER: validate.string().optional(),
+  MEILISEARCH_HOST: validate.string().optional().default('http://127.0.0.1:7700'),
+  MEILISEARCH_KEY: validate.string().optional(),
+})
+
+export type StacksEnv = validate.infer<typeof envVariables>
+
+export enum Type {
+  String = 'String',
+  Number = 'Number',
+  Boolean = 'Boolean',
+  Date = 'Date',
+  Object = 'Object',
+  Array = 'Array',
+}
+
 export { validate, z }

package/docs/.vitepress/config.ts

@@ -0,0 +1,9 @@
+/**
+ * This is the place where the VitePress documentation is defined.
+ * This is required because there is no way to set a custom
+ * path for the VitePress config.
+ */
+
+import docs from '../../../config/docs'
+
+export default docs

package/docs/README.md

@@ -0,0 +1,13 @@
+# Docs
+
+This folder contains the generated Stacks documentation.
+
+## How To
+
+To generate the documentation, run the following command:
+
+```bash
+pnpm run dev
+pnpm run build
+pnpm run deploy
+```

package/docs/node_modules/.bin/rimraf

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/src/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/src/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/rimraf@5.0.0/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/src/bin.js" "$@"
+else
+  exec node  "$basedir/../../../../node_modules/.pnpm/rimraf@5.0.0/node_modules/rimraf/dist/cjs/src/bin.js" "$@"
+fi

package/docs/node_modules/.bin/vitepress

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/vitepress@1.0.0-alpha.75_@algolia+client-search@4.17.0_@types+node@18.16.10/node_modules/vitepress/bin/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/vitepress@1.0.0-alpha.75_@algolia+client-search@4.17.0_@types+node@18.16.10/node_modules/vitepress/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/vitepress@1.0.0-alpha.75_@algolia+client-search@4.17.0_@types+node@18.16.10/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/runner/work/stacks/stacks/node_modules/.pnpm/vitepress@1.0.0-alpha.75_@algolia+client-search@4.17.0_@types+node@18.16.10/node_modules/vitepress/bin/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/vitepress@1.0.0-alpha.75_@algolia+client-search@4.17.0_@types+node@18.16.10/node_modules/vitepress/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/vitepress@1.0.0-alpha.75_@algolia+client-search@4.17.0_@types+node@18.16.10/node_modules:/home/runner/work/stacks/stacks/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../node_modules/.pnpm/vitepress@1.0.0-alpha.75_@algolia+client-search@4.17.0_@types+node@18.16.10/node_modules/vitepress/bin/vitepress.js" "$@"
+else
+  exec node  "$basedir/../../../../node_modules/.pnpm/vitepress@1.0.0-alpha.75_@algolia+client-search@4.17.0_@types+node@18.16.10/node_modules/vitepress/bin/vitepress.js" "$@"
+fi

package/docs/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "stacks-docs",
+  "type": "module",
+  "version": "0.51.0",
+  "packageManager": "pnpm@8.5.1",
+  "description": "The Stacks documentation.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/docs"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "documentation",
+    "vite",
+    "composables",
+    "headless",
+    "api",
+    "ssg",
+    "pwa",
+    "modern",
+    "typescript"
+  ],
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "scripts": {
+    "dev": "pnpm run copy-src && vitepress dev src",
+    "build": "pnpm run copy-src && vitepress build",
+    "preview": "pnpm run copy-src && vitepress preview",
+    "deploy": "pnpm run copy-src && wip",
+    "copy-src": "rimraf ./src/* && cp -R ../../docs/* ./src"
+  },
+  "dependencies": {
+    "@stacksjs/docs": "workspace:*",
+    "@stacksjs/path": "workspace:*",
+    "rimraf": "^5.0.0",
+    "vitepress": "^1.0.0-alpha.75"
+  }
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "stacks",
   "type": "module",
-  "version": "0.51.0",
-  "packageManager": "pnpm@7.26.3",
+  "version": "0.52.0",
+  "packageManager": "pnpm@8.5.1",
   "description": "The Stacks framework.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -39,11 +39,12 @@
     "Chris Breuer <chris@ow3.org>"
   ],
   "files": [
-    "buddy",
+    "api",
     "components",
     "core",
-    "examples",
-    "functions",
+    "database",
+    "desktop",
+    "docs",
     "pages",
     "tests",
     ".gitignore",
@@ -59,18 +60,58 @@
     "auto-imports.d.ts",
     "components.d.ts"
   ],
-  "engines": {
-    "node": ">=v18.14.0",
-    "pnpm": ">=7.26.3"
-  },
   "web-types": "./web-types.json",
-  "dependencies": {
-    "@stacksjs/buddy": "0.51.0"
+  "peerDependencies": {
+    "@stacksjs/actions": "0.52.0",
+    "@stacksjs/ai": "0.52.0",
+    "@stacksjs/alias": "0.52.0",
+    "@stacksjs/arrays": "0.52.0",
+    "@stacksjs/auth": "0.52.0",
+    "@stacksjs/buddy": "0.52.0",
+    "@stacksjs/build": "0.52.0",
+    "@stacksjs/cache": "0.52.0",
+    "@stacksjs/cli": "0.52.0",
+    "@stacksjs/cloud": "0.52.0",
+    "@stacksjs/collections": "0.52.0",
+    "@stacksjs/config": "0.52.0",
+    "@stacksjs/database": "0.52.0",
+    "@stacksjs/desktop": "0.52.0",
+    "@stacksjs/development": "0.52.0",
+    "@stacksjs/docs": "0.52.0",
+    "@stacksjs/domains": "0.52.0",
+    "@stacksjs/email": "0.52.0",
+    "@stacksjs/error-handling": "0.52.0",
+    "@stacksjs/events": "0.52.0",
+    "@stacksjs/faker": "0.52.0",
+    "@stacksjs/git": "0.52.0",
+    "@stacksjs/health": "0.52.0",
+    "@stacksjs/lint": "0.52.0",
+    "@stacksjs/logging": "0.52.0",
+    "@stacksjs/modules": "0.52.0",
+    "@stacksjs/notifications": "0.52.0",
+    "@stacksjs/objects": "0.52.0",
+    "@stacksjs/orm": "0.52.0",
+    "@stacksjs/pages": "0.52.0",
+    "@stacksjs/path": "0.52.0",
+    "@stacksjs/payments": "0.52.0",
+    "@stacksjs/realtime": "0.52.0",
+    "@stacksjs/router": "0.52.0",
+    "@stacksjs/search-engine": "0.52.0",
+    "@stacksjs/security": "0.52.0",
+    "@stacksjs/server": "0.52.0",
+    "@stacksjs/signals": "0.52.0",
+    "@stacksjs/storage": "0.52.0",
+    "@stacksjs/strings": "0.52.0",
+    "@stacksjs/testing": "0.52.0",
+    "@stacksjs/types": "0.52.0",
+    "@stacksjs/ui": "0.52.0",
+    "@stacksjs/utils": "0.52.0",
+    "@stacksjs/validation": "0.52.0"
   },
   "scripts": {
-    "buddy": "esno ./buddy/src/cli.ts",
-    "stx": "pnpm run buddy",
-    "stacks": "pnpm run buddy",
+    "buddy": "tsx ./core/buddy/src/cli.ts",
+    "build": "pnpm -r --filter='./core/**' build",
+    "dev": "pnpm -r --filter './core/**' dev",
     "prepublish": "pnpm buddy prepublish",
     "fresh": "pnpm buddy fresh",
     "clean": "pnpm buddy clean",
@@ -80,23 +121,24 @@
     "update:package-manager": "pnpm buddy update:package-manager",
     "update:node": "pnpm buddy update:node",
     "update:all": "pnpm buddy update:all",
-    "dev": "pnpm buddy dev",
-    "dev:components": "npx vite serve ./components/vue -c ./core/build/src/vue-components.ts",
-    "dev:desktop": "wip",
-    "dev:core": "pnpm --filter './core/**' dev",
-    "dev:docs": "vitepress dev ../apps/docs",
+    "dev:components": "vite serve ../../components/vue -c ../build/src/vue-components.ts",
+    "dev:core": "pnpm --filter '../core/**' --filter '!../buddy/' dev",
+    "dev:desktop": "vite serve ../../components/vue -c ../build/src/desktop.ts",
+    "dev:docs": "buddy dev:docs",
     "dev:pages": "nitro dev",
     "dev:functions": "pnpm buddy dev:functions",
     "development": "pnpm run dev",
-    "build": "pnpm buddy build",
     "build:components": "pnpm buddy build:components",
     "build:vue-components": "npx vite build -c ./core/build/src/vue-components.ts",
     "build:web-components": "npx vite build -c ./core/build/src/web-components.ts",
     "build:functions": "npx vite build -c ./core/build/src/functions.ts",
-    "build:docs": "npx vitepress build ../apps/docs",
+    "build:docs": "pnpm buddy build:docs",
     "build:pages": "npx vite-ssg build ./pages -c ./core/build/src/pages.ts",
-    "build:cli": "pnpm buddy build:cli",
     "build:core": "pnpm buddy build:core",
+    "build:buddy": "npx unbuild",
+    "build:cli": "pnpm run build:buddy",
+    "build:runtime": "pnpm run build:cli",
+    "build:desktop": "wip",
     "build:stacks": "pnpm buddy build:stacks",
     "build:all": "wip",
     "prod": "pnpm run build",
@@ -116,9 +158,9 @@
     "example": "wip",
     "example:vue": "pnpm run build:components && cd examples/vue && ln -sf ../../components/vue/dist dist && npx vite serve -c ../../core/build/example-vue.ts",
     "example:web-components": "pnpm run build:web-components && cd examples/web && ln -sf ../../components/web/dist dist && npx vite serve -c ../../core/build/example-wc.ts",
-    "lint": "buddy lint",
-    "lint:stacks": "buddy lint:stacks",
-    "lint:fix": "buddy lint:fix",
+    "lint": "pnpm buddy lint",
+    "lint:stacks": "pnpm buddy lint:stacks",
+    "lint:fix": "pnpm buddy lint:fix",
     "serve": "pnpm buddy serve",
     "serve:pages": "pnpm run dev:pages",
     "serve:functions": "pnpm run dev:functions",
@@ -127,7 +169,6 @@
     "make:function": "pnpm buddy make:function",
     "make:database": "pnpm buddy make:migration",
     "make:migration": "pnpm buddy make:migration",
-    "make:notification": "pnpm buddy make:notification",
     "make:factory": "pnpm buddy make:factory",
     "make:lang": "pnpm buddy make:lang",
     "make:stack": "pnpm buddy make:stack",
@@ -138,19 +179,18 @@
     "changelog": "pnpm buddy changelog",
     "generate": "pnpm buddy generate",
     "generate:entries": "pnpm buddy generate:entries",
-    "generate:vue-compat": "esno ./core/actions/src/generate-vue-compat.ts",
-    "generate:vscode-custom-data": "esno ./core/actions/src/generate-vscode-custom-data.ts",
+    "generate:vue-compat": "tsx ./core/actions/src/generate/vue-compat.ts",
+    "generate:vscode-custom-data": "tsx ./core/actions/src/generate/vscode-custom-data.ts",
     "generate:web-types": "vue-docgen-web-types -c ./core/build/web-types.config.cjs",
-    "generate:component-meta": "esno ./core/actions/src/component-meta.ts",
-    "generate:ide-helpers": "esno ./core/actions/src/generate-ide-helpers.ts",
+    "generate:component-meta": "tsx ./core/actions/src/generate/component-meta.ts",
+    "generate:ide-helpers": "tsx ./core/actions/src/generate/ide-helpers.ts",
     "generate:all": "pnpm buddy generate:all",
-    "types:generate": "vue-tsc --declaration --emitDeclarationOnly && esno ./core/actions/src/copy-types.ts",
-    "types:fix": "esno actions/src/fix-types.ts",
+    "types:generate": "vue-tsc --declaration --emitDeclarationOnly && tsx ./core/actions/src/copy-types.ts",
+    "types:fix": "tsx actions/src/fix-types.ts",
+    "add": "pnpm buddy add",
     "test": "pnpm buddy test",
-    "test:unit": "pnpm buddy test:unit",
-    "test:e2e": "pnpm buddy test:e2e",
     "test:ui": "pnpm buddy test:ui",
     "test:coverage": "pnpm buddy test:coverage",
-    "test:types": "vue-tsc --noEmit"
+    "test:types": "pnpm buddy test:types"
   }
 }

package/pages/desktop/.gitignore

@@ -0,0 +1,24 @@
+# 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?

package/pages/desktop/README.md

@@ -0,0 +1,73 @@
+# Vite Tauri Desktop Application Template
+
+This is a starter template for those who want to make a desktop application with web technologies. This template uses the below stack.
+
+### Vite.js
+
+Vite.js is a new modern bundler for javascript which is blazing fast and includes many sensible defaults.
+
+### Tauri
+
+Tauri is a new modern technology to turn your web apps into a desktop app for multiple platforms (Windows, MacOS, Linux, android and ios soon). Tauri apps have very small file size and tiny memory consumption.
+
+### Vue 3
+
+Vue.js is an incremental frontend framework which is an absolute joy to work with. It has seen very impressive improvements in version 3 including Composition Api, script setup, dynamic css binding and ... .
+
+### UnoCSS
+
+Vuetify is arguably the best component library for Vue 3 and is currently in alpha stage but will soon be ready for production. Lots of premade components will make your job as application developer easier and more fun.
+
+## Installation
+
+- Ready your workspace according to Tauri. [Tauri Getting Started](https://tauri.app/v1/guides/getting-started/prerequisites/)
+
+  - Note: You only need to install global things such as Rust and other OS level packages. Any thing related to application itself is already installed and ready for you.
+
+- Clone repository
+  - `git clone https://github.com/yooneskh/vite-tauri-template app-name`
+
+- `yarn` (or `npm install` but yarn is preferred)
+
+- Modify these files according to your app.
+
+  - ./index.html
+  - ./package.json
+  - ./public/favicon.svg
+  - ./src/icons/*
+  - ./src/tauri.conf.json
+
+## Development
+
+There are two ways you can develo your app.
+
+### In Browser
+
+- `yarn serve`
+  - launches vite and you can test and develop your app in the browser at <http://localhost:8080>.
+
+### In Tauri Window
+
+Launch two terminals and in
+
+1- `yarn serve:tauri`
+
+This launches Vite and configures [Unified Network](https://github.com/yooneskh/unified-network) (which is mine) to use Tauri for api calls (to get around CORS problems).
+
+2- `yarn serve:native`
+
+This launches Tauri window and you would see your app in the native window.
+
+**Note:** There are mainly 2 differences between development in browser and in Tauri window.
+
+- One is who executes your http calls, because when in browser, you are subject to CORS rules, but when testing in Tauri mode, Tauri's native module is executing the http calls so CORS will not be a problem.
+
+- Second is the renderer engine. In browsers, it is usually the latest modern engine, but in Tauri, it will be the OS's web engine, which is good, but maybe not as good as the browsers.
+
+## Building
+
+`yarn build` builds web application and packages them with Tauri in "./src/target/releases".
+
+## License
+
+Do whatever you want with it!

package/{core/x-ray → pages/desktop}/index.html

@@ -8,6 +8,6 @@
   </head>
   <body>
     <div id="app"></div>
-    <script type="module" src="./src/desktop/main.ts"></script>
+    <script type="module" src="/src/main.ts"></script>
   </body>
 </html>