58 lines
2.5 KiB
Markdown
58 lines
2.5 KiB
Markdown
# 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:
|
||
```bash
|
||
git clone https://forge.ftt.gmbh/ryanmwangi/Compware.git
|
||
cd compareware
|
||
```
|
||
2. Run the development server:
|
||
```bash
|
||
cargo leptos serve
|
||
```
|
||
3. Open your browser at [http://localhost:3000](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](https://forge.ftt.gmbh/ryanmwangi/Compware/issues).
|
||
- 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!
|
||
|