Giter VIP home page Giter VIP logo

garch's Introduction

garch

本项目的主要目的是:自动绘制互联网后端领域的系统架构图,并生成markdown说明文件。

首先使用者需要使用XML描述整个系统,具体示例详见项目中的demo目录。主要是遵循几点:

  1. 根目录下需要有个main.xml,层次依次为group,module。
  2. 为每个group建个同名目录,下面放所属module的XML描述文件。
  3. module定义了三大块:interfaces,functions,actions。

然后调用build.py生成markdown文档,调用方法:build.py path/to/main.xml。markdown文档中包含了自动生成的系统架构图(PNG格式)。

注意事项:

  1. 需要在build.py中设定全局变量OUTPUT,用于指定文档输出路径。默认OUTPUT=‘output’
  2. 自动生成系统架构图使用了graphviz,请先下载安装。然后在build.py中设定全局变量DOT,指定有向图生成工具的路径,在Windows下,默认DOT = 'C:\\Program Files (x86)\\Graphviz2.38\\bin\\dot.exe'

output目录是用demo生成的,仅供观摩。

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.