Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Latest commit eea4d2e May 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode moved code into src folder May 17, 2019
sample added sample May 17, 2019
src add deployment views May 28, 2019
.gitignore
README.md Update README.md May 28, 2019

README.md

Structurizr for TypeScript

npm version

This GitHub repository is a port of Structurizr for .NET to TypeScript, in order to help you visualise, document and explore the software architecture of a software system. In summary, it allows you to create a software architecture model based upon Simon Brown's C4 model.

How to use

  • Set up a new project similar to this sample

    npm init
    npm install -D @types/node
    npm install -D tsc
    npm install -D typescript
    npm install -S structurizr-typescript

  • Start coding your architecture model similar to the sample index.ts
    • For more detailed documentation on how to use Structurizr, please refer to Structurizr for .NET - the usage is pretty much the same
    • In the current version of this package, just a few of Structurizrs features are already implemented. See Limitations section below

Limitations

The current version of this package only supports:

  • Person, SoftwareSystem & Container entities
  • Relationships between those entities
  • System Context & Container diagrams
  • Deployment diagrams with DeploymentNode, ContainerInstance and HttpHealthCheck entities

This specifically excludes:

  • Component & Class entities as well as the related diagrams
  • Custom styles
  • Encrypted workspaces
  • Dynamic diagrams
  • Enterprise context diagrams

Also, as of now the package is not (automatically) tested yet - use at own risk :-)

You can’t perform that action at this time.