BUILD.md

BUILD

Table of contents

1. About

2. Environment

3. Development

3.1. Install and Run

3.2. Development with Visual Studio Code

3.3. Style Guide

4. Production

About

The BUILD.md is a file to check the environment and build specifications of horusec-c4model project.

Environment

• NodeJS: ^16.X
• Yarn: ^1.20.X
• GNU Make: ^4.2.X
• C4Build: ^0.2.5
• Graphviz: ^2.49.X
• Docker: ^20.10.X
• PlantUML-vscode: ^2.16.X

Development

Horusec's C4Model has two languages: Portuguese and English.

Install and Run

Access the directory of the language you want to work with:

Example:

cd pt-br/

And then run the command below:

make run

The web server will be available at the address: http://localhost:3000

Development with Visual Studio Code

You can use the text editor Visual Studio Code to assist in the development of this project.

In the .vscode directory, create a file called settings.json and apply these settings:

"plantuml.server": "http://127.0.0.1:8080",
"plantuml.render": "PlantUMLServer"

And then run the following command to create a docker container of plantuml-server:

make up plantuml

So, when editing the .puml files, you can get a preview through Visual Studio Code by running the shortcut:

ALT+D

Style Guide

All project files must have the license header. You can check if all files are in agreement by running the following command in project root:

make license

If it is necessary to add the license in any file, run the command below to insert it in all files that do not have it:

make license-fix

Production

To generate a production build, run the command below at the root of the project:

make build

A directory named docs will be generated in the paths pt-br/ and en/, it will contain the compiled project ready to be hosted on a web server.