Giter VIP home page Giter VIP logo

diagram-as-code's Introduction

Diagram as Code Example Using Structurizr and C#

Running Locally

  1. Run the Structurizr On-Premise Docker Image
  2. docker run -it --rm -p 8080:8080 -v PATH:/usr/local/structurizr structurizr/onpremises
  3. Replace PATH with your path to a directory where structurizer can save its state
  4. Navigate to localhost:8080
  5. Login with default username (structurizr) and password (password)
  6. Create a new workspace.
  7. Go to Settings of the workspace
  8. Find the API Key and API Secret
  9. Set environment variables 1. STRUCTURIZR_API_KEY - The API Key of your workspace 1. STRUCTURIZR_API_SECRET - The API Secret off your workspace 1. STRUCTURIZR_WORKSPACE_ID - The ID of your workspace
  10. Go to src/MyDiagrams and run dotnet run command
  11. Your workspace should have been updated now with the diagram defined in your C# code.
  12. For the first time, your diagram's layout will be a mess, you can edit the diagram in the browser and click Auto Layout (the magic wand icon), then save the diagram. Any subsequent run of this program will then respect the layout.

References

  1. Structurizr Getting Started
  2. Structurizr C# Client

diagram-as-code's People

Contributors

randalvance avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.