https://github.com/storj/illustrated

Diagrams to understand Storj architecture and internals better.
https://github.com/storj/illustrated

storj

Last synced: 8 days ago
JSON representation

Diagrams to understand Storj architecture and internals better.

• Host: GitHub
• URL: https://github.com/storj/illustrated
• Owner: storj
• License: other
• Created: 2021-10-08T06:36:24.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T07:01:51.000Z (6 months ago)
• Last Synced: 2024-08-02T02:11:40.995Z (3 months ago)
• Topics: storj
• Homepage: https://storj.github.io/illustrated/
• Size: 738 KB
• Stars: 6
• Watchers: 21
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-storj - Storj illustrated - diagrams to explain internals of Storj architecture (Tokeneconomics)

README

        
# Storj on Diagrams

Diagrams are under: https://github.com/storj/illustrated/tree/master/docs

But it's also visible in one HTML page at: https://storj.github.io/illustrated/

The diagrams represent my (may or may not be good) understanding.

If you see any problems, please create an issue.

If you need something to be explained, please create an issue.

## Diagrams

![docs/0title.svg](docs/0title.svg)

```

```

![docs/overview.svg](docs/overview.svg)

```

```

![docs/core.svg](docs/core.svg)

```

```

![docs/authservice.svg](docs/authservice.svg)

```

```

![docs/delete.svg](docs/delete.svg)

```

```

![docs/edge.svg](docs/edge.svg)

```

```

![docs/encrypted-keys.svg](docs/encrypted-keys.svg)

```

```

![docs/encrypted-path.svg](docs/encrypted-path.svg)

```

```

![docs/grant.svg](docs/grant.svg)

```

```

![docs/identity.svg](docs/identity.svg)

```

```

![docs/macaroon.svg](docs/macaroon.svg)

```

```

![docs/pieces.svg](docs/pieces.svg)

```

```

![docs/ranged-loop.svg](docs/ranged-loop.svg)

```

```

![docs/read1.svg](docs/read1.svg)

```

```

![docs/read2.svg](docs/read2.svg)

```

```

![docs/reputation.svg](docs/reputation.svg)

```

```

![docs/satellite-api.svg](docs/satellite-api.svg)

```

```

![docs/secrets.svg](docs/secrets.svg)

```

```

![docs/signatures.svg](docs/signatures.svg)

```

```

![docs/storagenode-accounting.svg](docs/storagenode-accounting.svg)

```

```

![docs/versioncontrol.svg](docs/versioncontrol.svg)

## How to contribute

Original source of the diagrams can be edited with online or offline version of [diagrams.net](https://app.diagrams.net)

When one diagram is saved, both the export (svg) both the embedded source are updated. 

PR can be created where the old version and new version of the SVG can be seen, just click to the *rich diff* option:

![Rich diff](https://user-images.githubusercontent.com/170549/137105249-4fc31311-dbe0-49a9-82d9-37dace8ebcfa.png)

To regenerate the previews, the following can be used (after existing lines are removed):

```

ls -1 docs/*.svg | sort | xargs -n1 -IFILE printf "![FILE](FILE)\n\n```\n\n\n\n```\n\n"         

```

(tested in fish)