Here is a short "getting started" guide to using Structurizr, and creating software architecture models using the client libraries.
1. Sign up for a free account
Before you can do anything, you will need to sign up for a free Structurizr account using the sign up page.
2. Sign in
Once you've signed up for an account, you can sign in to get to your dashboard page.
5. Modify the workspace ID, API key and secret
If you load the project into your IDE of choice, you'll see that the quick start projects include a simple console application. There are some constants at the top of the source code file that need to be changed to reflect the details of the workspace you created.
private static final long WORKSPACE_ID = 1234; private static final String API_KEY = "key"; private static final String API_SECRET = "secret";
private const long WorkspaceId = 1234; private const string ApiKey = "key"; private const string ApiSecret = "secret";
You can find the workspace ID, API key and secret on your dashboard, by clicking the "Show more..." button associated with the workspace.
6. Run the console application
Running the console application will create a software architecture model and upload it, via the web API, to Structurizr.
7. Open the workspace in Structurizr
Clicking the workspace name/thumbnail on your dashboard will open the workspace summary, from where you can open the diagram viewer to see the diagram that was created by the console application.
Here, you can move the diagram elements around and change the paper size. The diagram layout can be saved by clicking the save button.