docs

.vscode/extensions.json

@@ -3,6 +3,8 @@
     "Vue.volar",
     "tauri-apps.tauri-vscode",
     "rust-lang.rust-analyzer",
-    "editorconfig.editorconfig"
+    "editorconfig.editorconfig",
+    "tamasfe.even-better-toml",
+    "syler.sass-indented"
   ]
 }

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2025 Goldenwere
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,16 +1,20 @@
-# Tauri + Vue + TypeScript
+# simple-inventory-editor
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+A simple, offline, table-based home-inventory editor.
 
-## Recommended IDE Setup
+## Using the App
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
+TBA
 
-## Type Support For `.vue` Imports in TS
+## Local Development
 
-Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
+### Getting Started
 
-1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
-2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
+1. Install the pre-reqs for [tauri](https://tauri.app/start/prerequisites/) (webview dev dependencies, rust, and node)
+2. run `npm ci` to install dependencies
+3. run `npm run tauri dev` to start the app; this will install rust dependencies when run for the first time
+4. run `npm run tauri build` to build the app; see the [distribute documentation](https://tauri.app/distribute/) for more information
 
-You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
+### Architecture
+
+simple-inventory-editor uses [tauri](https://tauri.app/), which makes use of the system's "webview" in place of bundling an entire browser with the app. Tauri splits lower-level system functionality (`src-tauri`: rust) from the front-end UI (`src`: node (vite, vue, primevue)). Most of the lower-level functionality necessary for the app has been abstracted into node plugins to be easily called from the front-end, so the tauri source's main responsibility is largely just creating the window.

package-lock.json

@@ -10,8 +10,8 @@
       "dependencies": {
         "@primeuix/themes": "1.0.0",
         "@tauri-apps/api": "2.3.0",
-        "@tauri-apps/plugin-dialog": "^2.2.0",
-        "@tauri-apps/plugin-fs": "^2.2.0",
+        "@tauri-apps/plugin-dialog": "2.2.0",
+        "@tauri-apps/plugin-fs": "2.2.0",
         "@tauri-apps/plugin-opener": "2.2.6",
         "pinia": "3.0.1",
         "primeicons": "7.0.0",

package.json

@@ -1,5 +1,6 @@
 {
   "name": "simple-inventory-editor",
+  "description": "A simple, offline, table-based home-inventory editor.",
   "private": true,
   "version": "0.1.0",
   "type": "module",
@@ -12,8 +13,8 @@
   "dependencies": {
     "@primeuix/themes": "1.0.0",
     "@tauri-apps/api": "2.3.0",
-    "@tauri-apps/plugin-dialog": "^2.2.0",
-    "@tauri-apps/plugin-fs": "^2.2.0",
+    "@tauri-apps/plugin-dialog": "2.2.0",
+    "@tauri-apps/plugin-fs": "2.2.0",
     "@tauri-apps/plugin-opener": "2.2.6",
     "pinia": "3.0.1",
     "primeicons": "7.0.0",

src-tauri/Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 name = "simple-inventory-editor"
 version = "0.1.0"
-description = "A Tauri App"
-authors = ["you"]
+description = "A simple, offline, table-based home-inventory editor."
+authors = ["Goldenwere"]
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html