neuronic 0.1.0

Real-time graphical visualization of Caryatid message bus flow
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# Contributing to Neuronic

Thanks for your interest in contributing to Neuronic!

## Getting Started

1. Fork and clone the repository
2. Install Rust 1.85+ via [rustup](https://rustup.rs/)
3. Run `cargo build` to verify everything compiles
4. Run `cargo test` to run the test suite

## Development

### Running locally

```bash
# With a config file
cargo run -- --config neuronic.toml

# With debug logging
cargo run -- --debug
```

You'll need a RabbitMQ instance with Caryatid monitor snapshots being published. See the [README](README.md) for configuration details.

### Code style

We use standard Rust formatting and linting:

```bash
cargo fmt --check
cargo clippy --all-targets --all-features -- -D warnings
```

### Running tests

```bash
cargo test
```

## Pull Requests

1. Create a feature branch from `main`
2. Make your changes
3. Run `cargo fmt` and `cargo clippy`
4. Run `cargo test`
5. Update CHANGELOG.md if applicable
6. Submit a PR with a clear description of the changes

### Commit messages

Use clear, descriptive commit messages. We loosely follow [Conventional Commits](https://www.conventionalcommits.org/):

- `feat:` new features
- `fix:` bug fixes
- `docs:` documentation changes
- `refactor:` code refactoring
- `test:` adding or updating tests
- `chore:` maintenance tasks

## Architecture

The codebase is organized as follows:

```
src/
├── main.rs           # CLI entry point
├── config.rs         # Configuration loading
├── subscriber.rs     # RabbitMQ connection
├── graph.rs          # Graph data model
└── ui/
    ├── app.rs        # Main eframe application
    ├── theme.rs      # Color themes
    ├── drawing.rs    # Graph rendering
    ├── layout.rs     # Layout algorithms
    ├── animations.rs # Visual effects
    ├── input.rs      # User interaction
    ├── panels.rs     # Side panels
    ├── search.rs     # Search functionality
    └── export.rs     # Export features
```

## Issues

Check the [issue tracker](https://github.com/lowhung/neuronic/issues) for open issues. Issues labeled `good first issue` are a good starting point.

## License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 license.