# Welcome to HSuite

<div align="center"><img src="https://hsuite.finance/wp-content/uploads/2023/08/Hsuite2-300x300.png" alt="HSuite Logo" width="200"></div>

Enterprise-grade and Degen-grade Web3 Infrastructure Platform

[![Docs](https://img.shields.io/badge/docs-reference-blue.svg)](https://docs.hsuite.network/smart-node) [![Discord](https://img.shields.io/badge/discord-online-brightgreen.svg)](https://discord.gg/hbarsuite) [![Website](https://img.shields.io/badge/website-hsuite-blue.svg)](https://hbarsuite.network) [![Twitter](https://img.shields.io/twitter/follow/hbarsuite?style=social)](https://twitter.com/hbarsuite)

Welcome to the HSuite documentation. This repository contains comprehensive documentation for both developers and general users of the HSuite ecosystem, a platform that bridges the gap between enterprise and retail blockchain solutions.

## Core Components

### Smart Node

* Professional node infrastructure solution
* Enterprise-grade deployment and management
* Status monitoring and configuration updates
* Comprehensive CLI tools
* Docker and Kubernetes integration
* Network operations and utility management
* Private SmartNode Network capabilities (B2B)

### Smart Registry

* Metadata management and storage
* Security guards and access control
* Docker integration
* Event tracking and monitoring
* RESTful API for registry interactions
* DID as a Service integration (B2B)

### Smart App

* Core module for application logic
* Real-time socket communication
* Environment-based configuration
* Business logic implementation
* Authentication and access control
* Web3 integration with custom WebSocket
* Banking as a Service features (B2B)

### DeFi Solutions

* **Zero Slippage DEX** (B2B/B2C)
  * Advanced decentralized exchange
  * Minimal slippage mechanisms
  * Professional trading tools
* **Cross-Chain DEX** (B2B/B2C)
  * Seamless cross-chain trading
  * Multi-chain support
  * Bridge infrastructure
* **NFT Exchange** (B2B/B2C)
  * Creator tools (minting, royalties, collections)
  * Collector features (trading, portfolio tracking)
  * Trader tools (analytics, alerts, batch operations)
  * Advanced trading mechanisms
  * Community and social features

### Enterprise Solutions

* **Multi-Signature Manager** (B2B/B2C)
  * Secure wallet management
  * Transaction approval workflows
  * Enterprise-grade security
* **Real-Estate as a Service** (B2B)
  * Blockchain-based property management
  * Digital asset tokenization
  * Real estate operations

## Documentation Structure

### [Developer Documentation](/developers.md)

Comprehensive technical documentation for developers:

* API References and SDK Integration
* Smart App Development
* Architecture Overview
* Technical Specifications
* Deployment Guides
* Security Best Practices
* Development Guidelines
* Testing Protocols

### [General Documentation](/general.md)

User-focused documentation and guides:

* Product Overviews
* User Guides and Tutorials
* FAQs and Troubleshooting
* Network Information
* Support Resources
* Best Practices
* Security Guidelines

## Technical Stack

* **Backend Framework**: NestJS
* **Frontend**: Ionic Framework / Vue.js
* **Language**: TypeScript
* **Databases**: MongoDB, Redis
* **Network**: Hedera Hashgraph
* **Storage**: IPFS
* **Containerization**: Docker, Kubernetes
* **Documentation**: Swagger/OpenAPI
* **Desktop**: Electron

## Quick Links

* [Website](https://hsuite.finance)
* [Discord Community](https://discord.gg/BtRCRYvJmB)
* [Twitter](https://twitter.com/hbarsuite)
* [GitHub Repository](https://github.com/HSuiteNetwork)
* [API Reference](/restful-api.md)

## Contributing

We welcome contributions to improve our documentation and codebase. Please see our [contribution guidelines](https://github.com/HSuiteNetwork/smart-engines/blob/master/docs/CONTRIBUTING.md) for more information on:

1. Forking the repository
2. Creating feature branches
3. Submitting pull requests
4. Code review process
5. Development guidelines

## License

This documentation and all HSuite components are covered by the project's license terms.

***

Built with ❤️ by the HSuite Team


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hsuite.network/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
