build: add necessary dependencies

docs(README): edit README.md to clarify the project.
2024-12-09 19:29:15 +03:00 · 2024-12-09 19:26:53 +03:00
4 changed files with 72 additions and 102 deletions
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@ -23,31 +23,31 @@
  <component name="ProblemsViewState">
    <option name="showPreview" value="true" />
  </component>
-  <component name="ProjectColorInfo"><![CDATA[{
-  "associatedIndex": 8
-}]]></component>
+  <component name="ProjectColorInfo">{
+  &quot;associatedIndex&quot;: 8
+}</component>
  <component name="ProjectId" id="2pngw94pMiCvlaySWR2RUofHfwc" />
  <component name="ProjectViewState">
    <option name="hideEmptyMiddlePackages" value="true" />
    <option name="showLibraryContents" value="true" />
  </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "RunOnceActivity.git.unshallow": "true",
-    "RunOnceActivity.rust.reset.selective.auto.import": "true",
-    "git-widget-placeholder": "main",
-    "node.js.detected.package.eslint": "true",
-    "node.js.detected.package.tslint": "true",
-    "node.js.selected.package.eslint": "(autodetect)",
-    "node.js.selected.package.tslint": "(autodetect)",
-    "nodejs_package_manager_path": "npm",
-    "org.rust.cargo.project.model.PROJECT_DISCOVERY": "true",
-    "org.rust.cargo.project.model.impl.CargoExternalSystemProjectAware.subscribe.first.balloon": "",
-    "org.rust.first.attach.projects": "true",
-    "vue.rearranger.settings.migration": "true"
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.git.unshallow&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.rust.reset.selective.auto.import&quot;: &quot;true&quot;,
+    &quot;git-widget-placeholder&quot;: &quot;main&quot;,
+    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
+    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
+    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
+    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
+    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
+    &quot;org.rust.cargo.project.model.PROJECT_DISCOVERY&quot;: &quot;true&quot;,
+    &quot;org.rust.cargo.project.model.impl.CargoExternalSystemProjectAware.subscribe.first.balloon&quot;: &quot;&quot;,
+    &quot;org.rust.first.attach.projects&quot;: &quot;true&quot;,
+    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
  }
-}]]></component>
+}</component>
  <component name="RunManager" selected="Cargo.Run compareware">
    <configuration name="Run compareware" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
      <option name="buildProfileId" value="dev" />
@ -96,7 +96,7 @@
      <option name="number" value="Default" />
      <option name="presentableId" value="Default" />
      <updated>1733407491778</updated>
-      <workItem from="1733407498746" duration="4156000" />
+      <workItem from="1733407498746" duration="5306000" />
    </task>
    <servers />
  </component>
--- a/Cargo.lock
+++ b/Cargo.lock
@ -504,8 +504,9 @@ dependencies = [
 "leptos_meta",
 "leptos_router",
 "serde",
- "uuid 0.8.2",
+ "uuid",
 "wasm-bindgen",
+ "web-sys",
 ]

 [[package]]
@ -1381,7 +1382,7 @@ dependencies = [
 "server_fn_macro",
 "syn 2.0.90",
 "tracing",
- "uuid 1.11.0",
+ "uuid",
 ]

 [[package]]
@ -2535,12 +2536,6 @@ version = "1.0.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be"

-[[package]]
-name = "uuid"
-version = "0.8.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bc5cf98d8186244414c848017f0e2676b3fcb46807f6668a97dfe67359a3c4b7"
-
 [[package]]
 name = "uuid"
 version = "1.11.0"
@ -2580,9 +2575,9 @@ checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"

 [[package]]
 name = "wasm-bindgen"
-version = "0.2.95"
+version = "0.2.96"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "128d1e363af62632b8eb57219c8fd7877144af57558fb2ef0368d0087bddeb2e"
+checksum = "21d3b25c3ea1126a2ad5f4f9068483c2af1e64168f847abe863a526b8dbfe00b"
 dependencies = [
 "cfg-if",
 "once_cell",
@ -2591,9 +2586,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-backend"
-version = "0.2.95"
+version = "0.2.96"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cb6dd4d3ca0ddffd1dd1c9c04f94b868c37ff5fac97c30b97cff2d74fce3a358"
+checksum = "52857d4c32e496dc6537646b5b117081e71fd2ff06de792e3577a150627db283"
 dependencies = [
 "bumpalo",
 "log",
@ -2618,9 +2613,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-macro"
-version = "0.2.95"
+version = "0.2.96"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e79384be7f8f5a9dd5d7167216f022090cf1f9ec128e6e6a482a2cb5c5422c56"
+checksum = "920b0ffe069571ebbfc9ddc0b36ba305ef65577c94b06262ed793716a1afd981"
 dependencies = [
 "quote",
 "wasm-bindgen-macro-support",
@ -2628,9 +2623,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-macro-support"
-version = "0.2.95"
+version = "0.2.96"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "26c6ab57572f7a24a4985830b120de1594465e5d500f24afe89e16b4e833ef68"
+checksum = "bf59002391099644be3524e23b781fa43d2be0c5aa0719a18c0731b9d195cab6"
 dependencies = [
 "proc-macro2",
 "quote",
@ -2641,9 +2636,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-shared"
-version = "0.2.95"
+version = "0.2.96"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "65fc09f10666a9f147042251e0dda9c18f166ff7de300607007e96bdebc1068d"
+checksum = "e5047c5392700766601942795a436d7d2599af60dcc3cc1248c9120bfb0827b0"

 [[package]]
 name = "wasm-streams"
--- a/Cargo.toml
+++ b/Cargo.toml
@ -15,9 +15,10 @@ leptos = { version = "0.6" }
 leptos_meta = { version = "0.6" }
 leptos_actix = { version = "0.6", optional = true }
 leptos_router = { version = "0.6" }
-wasm-bindgen = "=0.2.95"
+wasm-bindgen = "=0.2.96"
 serde = { version = "1.0", features = ["derive"] }
-uuid = "0.8"
+uuid = { version = "1.0", features = ["v4"] }
+web-sys = { version = "0.3", features = ["Event"] }

 [features]
 csr = ["leptos/csr", "leptos_meta/csr", "leptos_router/csr"]
--- a/README.md
+++ b/README.md
@ -1,72 +1,46 @@
-<picture>
-    <source srcset="https://raw.githubusercontent.com/leptos-rs/leptos/main/docs/logos/Leptos_logo_Solid_White.svg" media="(prefers-color-scheme: dark)">
-    <img src="https://raw.githubusercontent.com/leptos-rs/leptos/main/docs/logos/Leptos_logo_RGB.svg" alt="Leptos Logo">
-</picture>
+# CompareWare

-# Leptos Starter Template
+CompareWare is an open-source platform for comparing tools (software, hardware, etc.) with structured, crowdsourced data. It combines **Leptos** for a modern, reactive frontend and **Nostr** for decentralized data storage.

-This is a template for use with the [Leptos](https://github.com/leptos-rs/leptos) web framework and the [cargo-leptos](https://github.com/akesson/cargo-leptos) tool.
+## **Features**
+- **Item Management**: Add, view, and manage items with metadata and key-value tags.
+- **Nostr Integration**: 
+  - Store and share data as Nostr events.
+  - Authenticate users with Nostr keys.
+- **Future Features**: Reviews and a Web of Trust for collaborative insights.

-## Creating your template repo

-If you don't have `cargo-leptos` installed you can install it with
+## **Getting Started**

-`cargo install cargo-leptos --locked`
+### Prerequisites
+- Rust (latest stable version)
+- Leptos framework

-Then run
-
-`cargo leptos new --git leptos-rs/start`
-
-to generate a new project template (you will be prompted to enter a project name).
-
-`cd {projectname}`
-
-to go to your newly created project.
-
-Of course, you should explore around the project structure, but the best place to start with your application code is in `src/app.rs`.
-
-## Running your project
-
-`cargo leptos watch`  
-By default, you can access your local project at `http://localhost:3000`
-
-## Installing Additional Tools
-
-By default, `cargo-leptos` uses `nightly` Rust, `cargo-generate`, and `sass`. If you run into any trouble, you may need to install one or more of these tools.
-
-1. `rustup toolchain install nightly --allow-downgrade` - make sure you have Rust nightly
-2. `rustup target add wasm32-unknown-unknown` - add the ability to compile Rust to WebAssembly
-3. `cargo install cargo-generate` - install `cargo-generate` binary (should be installed automatically in future)
-4. `npm install -g sass` - install `dart-sass` (should be optional in future)
-
-## Executing a Server on a Remote Machine Without the Toolchain
-After running a `cargo leptos build --release` the minimum files needed are:
-
-1. The server binary located in `target/server/release`
-2. The `site` directory and all files within located in `target/site`
-
-Copy these files to your remote server. The directory structure should be:
-```text
-leptos_start
-site/
+### Installation
+1. Clone the repository:
+   ```bash
+   git clone https://forge.ftt.gmbh/ryanmwangi/Compware.git
+   cd compareware
   ```
-Set the following environment variables (updating for your project as needed):
-```sh
-export LEPTOS_OUTPUT_NAME="leptos_start"
-export LEPTOS_SITE_ROOT="site"
-export LEPTOS_SITE_PKG_DIR="pkg"
-export LEPTOS_SITE_ADDR="127.0.0.1:3000"
-export LEPTOS_RELOAD_PORT="3001"
+2. Run the development server:
+   ```bash
+   cargo leptos serve
   ```
-Finally, run the server binary.
+3. Open your browser at [http://localhost:3000](http://localhost:3000)

-## Notes about CSR and Trunk:
-Although it is not recommended, you can also run your project without server integration using the feature `csr` and `trunk serve`:
+## **Roadmap**

-`trunk serve --open --features csr`
+1. **Item Management** (In progress)
+   - Implement a form (`item_form.rs`) to allow users to add new items with metadata and key-value tags.
+   - Create a listing component (`items_list.rs`) to display and manage added items.
+   - Add backend functionality to validate and persist items using the Leptos framework.

-This may be useful for integrating external tools which require a static site, e.g. `tauri`.
+2. **Review System** (To be implemented)
+   - Design a data model to handle reviews, including ratings, comments, and reviewer metadata.
+   - Build a user interface for submitting and viewing reviews linked to specific items.
+   - Integrate filters and sorting to display reviews based on relevance and ratings.

-## Licensing
-
-This template itself is released under the Unlicense. You should replace the LICENSE for your own application with an appropriate license if you plan to release it publicly.
+3. **Nostr Integration** (To be integrated)
+   - Use Nostr events for decentralized data storage, mapping item data to specific Nostr event types.
+   - Authenticate users through their Nostr keys for secure and decentralized access.
+   - Enable data sharing and synchronization with Nostr-compatible clients.
Author	SHA1	Message	Date
Ryan Mwangi	4137ded856	build: add necessary dependencies	2024-12-09 19:29:15 +03:00
Ryan Mwangi	ba95f7b914	docs(README): edit README.md to clarify the project.	2024-12-09 19:26:53 +03:00