ryanmwangi/Compware
1
0
Fork 0
Code Issues Pull requests Releases Activity
No description
104 commits 7 branches 7 tags 1.3 MiB
Rust 89.6%
CSS 6.2%
TypeScript 4.1%
Find a file
Exact
ryan 443c7a7e0c build(files): remove unused item_form.rs and wikidata_lookup.rs files
2025-02-06 22:19:42 +03:00
assets feat(editable cells): add support for multiple input types in EditableCell component 2025-01-10 20:56:25 +03:00
end2end feat(form): add form validation for name and description fields 2024-12-18 14:52:30 +03:00
src build(files): remove unused item_form.rs and wikidata_lookup.rs files 2025-02-06 22:19:42 +03:00
style feat: update leptos to newest version 2024-12-06 14:45:14 +03:00
.gitignore build(git): add compareware.db file to .gitignore 2025-01-27 16:38:23 +03:00
Cargo.lock feat(item_list): implement querying using GRAPHQL 2025-02-01 05:28:36 +03:00
Cargo.toml feat(item_list): implement querying using GRAPHQL 2025-02-01 05:28:36 +03:00
LICENSE feat: update leptos to newest version 2024-12-06 14:45:14 +03:00
README.md docs(README): document ways to collaborate on the project 2025-01-13 15:50:41 +03:00
ROADMAP.md docs(ROADMAP): add ROADMAP.md file to document the current state of the project and the next steps. 2025-01-13 15:51:24 +03:00
rust-toolchain.toml build(toolchain): update rust-toolchain.toml to use Rust 1.82.0 instead of 1.83.0 2025-01-23 00:02:48 +03:00

README.md

CompareWare

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.

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.

Getting Started

Prerequisites

  • Rust (latest stable version)
  • Leptos framework

Installation

  1. Clone the repository: 
    git clone https://forge.ftt.gmbh/ryanmwangi/Compware.git
cd compareware
  2. Run the development server: 
    cargo leptos serve
  3. Open your browser at http://localhost:3000

Collaboration

We welcome contributions! Here’s how you can help:

1. Contribute Code

  • Fork the repository and create a new branch for your feature or fix.
  • Ensure your changes are well-tested and include documentation if necessary.
  • Open a pull request describing the changes and why they are useful.

2. Report Issues

  • If you encounter bugs or have suggestions, please open an issue on the Issues page.
  • Provide as much detail as possible, including steps to reproduce the issue and relevant error messages.

3. Feature Suggestions

  • We are constantly looking to improve CompareWare. If you have ideas for new features, please share them in the Issues section.
  • You can also help us prioritize future work by commenting or upvoting on existing feature requests.

4. Documentation Contributions

  • If you spot areas in the documentation that need improvement or if you have suggestions for clearer explanations, please feel free to submit a pull request with the updates.
  • Helping others understand the project is just as valuable as contributing code!

5. Community and Discussion

  • Feel free to ask questions, provide feedback, or engage in discussions related to CompareWare’s development.

6. Test and Review

  • Help by reviewing pull requests to ensure the code meets our standards and is bug-free.
  • Test new features and provide feedback to improve their functionality and usability.

We appreciate any contributions that can help improve CompareWare and make it more useful for the community!