mirror of
https://github.com/hcengineering/platform.git
synced 2026-08-25 22:02:23 +02:00
Add getting starting diagram
This commit is contained in:
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
|
||||
- Comprehensive documentation and examples
|
||||
- GitHub community health files (CONTRIBUTING.md, SECURITY.md)
|
||||
- Issue and PR templates
|
||||
@@ -15,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
## [0.7.9] - 2025-10-01
|
||||
|
||||
### Added
|
||||
|
||||
- Initial public release
|
||||
- Core network implementation with distributed architecture
|
||||
- ZeroMQ-based RPC communication layer
|
||||
@@ -28,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- Full documentation and examples
|
||||
|
||||
### Features
|
||||
|
||||
- Distributed load balancing across multiple agents
|
||||
- Container lifecycle management with reference counting
|
||||
- Event broadcasting capabilities
|
||||
|
||||
+6
-6
@@ -155,17 +155,17 @@ interface MyOptions {
|
||||
export class MyClass {
|
||||
// Private fields first
|
||||
private readonly config: MyOptions
|
||||
|
||||
|
||||
// Constructor
|
||||
constructor(options: MyOptions) {
|
||||
this.config = options
|
||||
}
|
||||
|
||||
|
||||
// Public methods
|
||||
async doSomething(): Promise<void> {
|
||||
// Implementation
|
||||
}
|
||||
|
||||
|
||||
// Private methods
|
||||
private helper(): void {
|
||||
// Implementation
|
||||
@@ -205,14 +205,14 @@ describe('ComponentName', () => {
|
||||
it('should behave correctly under normal conditions', async () => {
|
||||
// Arrange
|
||||
const component = new ComponentName()
|
||||
|
||||
|
||||
// Act
|
||||
const result = await component.methodName()
|
||||
|
||||
|
||||
// Assert
|
||||
expect(result).toBe(expected)
|
||||
})
|
||||
|
||||
|
||||
it('should handle error conditions', async () => {
|
||||
// Test error cases
|
||||
})
|
||||
|
||||
@@ -15,6 +15,33 @@ Build enterprise-grade distributed systems with automatic service discovery, hig
|
||||
|
||||
[Features](#-why-build-your-product-on-huly-network) • [Quick Start](#-getting-started) • [Documentation](#-documentation) • [Examples](#-examples) • [API Reference](#-api-reference) • [Contributing](#-contributing)
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
subgraph Learn["📚 STEP 1: Core Concepts"]
|
||||
direction TB
|
||||
Network["🌐 Network Server<br/>Central hub, Port 3737<br/>⚠️ Single instance only"]
|
||||
Agent["🤖 Agent<br/>Runs containers<br/>✅ Multiple instances OK"]
|
||||
Container["📦 Container<br/>Your business logic<br/>Implements interface"]
|
||||
Client["💻 Client<br/>Requests containers<br/>Sends operations"]
|
||||
end
|
||||
|
||||
Learn --> Deploy
|
||||
|
||||
subgraph Deploy["🚀 STEP 2: Production Features"]
|
||||
direction TB
|
||||
P1["⚡ High Availability<br/>Multiple agents, auto-failover"]
|
||||
P2["🎯 Multi-tenancy<br/>Labels & routing"]
|
||||
P3["📡 Event Broadcasting<br/>Real-time updates"]
|
||||
P4["📈 Scale & Monitor<br/>Add agents, track health"]
|
||||
end
|
||||
|
||||
Deploy --> Success([🎉 Production Ready!])
|
||||
|
||||
style Success fill:#ffd700,stroke:#f57f17,stroke-width:3px
|
||||
style Learn fill:#e3f2fd,stroke:#1976d2
|
||||
style Deploy fill:#e8f5e9,stroke:#388e3c
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user