dedalusj / cloudgram

Generate diagrams for your cloud architecture using code
https://cloudgram.dedalusone.com
Apache License 2.0
94 stars 5 forks source link
architecture cloud diagram diagram-generator diagrams-as-code

CloudGram

License Test

CloudGram lets you generate diagrams for your cloud architecture directly in your browser using code in a syntax similar to the DOT language and familiar to GraphViz users.

To start using CloudGram navigate to https://cloudgram.dedalusone.com and follow the examples and online editor to experiment visualizing your architecture.

Development

Pre-requisites

Bootstrap

Upon cloning the project install the dependencies with yarn install. Beside install the project dependencies this will also install git hooks that will run tests and linting on every commit.

Running

Use the yarn run dev command to launch a dev server that will also watch for files changes and recompile if necessary. The app will be accessible at http://localhost:1234/.

Deployment

Use yarn run build to build the minified production assets and build.

The infra directory contains an example CloudFormation template to set up an S3 bucket, and a CloudFront distribution to serve CloudGram via CDN.

Regenerating service icons

The command yarn run assets can be used to automatically regenerate the SVG and JS files for the service icons for the supported providers. The command runs the scripts/assets,js node script. Currently, the script will always regenerate the icons for all providers hence no command line options are supported.

Regenerating grammar diagram

To regenerate the grammar diagram HTML, the src/grammar_diagram.html file, use the yarn run diagram command. This command is also run automatically at commit time via git hooks.

Related projects

CloudGram is inspired by the diagrams project.