Beagle C4Model

Table of contents

1. About

2. Getting started

2.1. Requirements

3. Usage

3.1. Structure

3.2. Generating docs files

3.3. Changing configurations

4. Documentation

5. Contributing

6. License

7. Community

About

This project was created using c4builder. See below the tools we used:

• Markdown creates rich text documents from plain text.

• C4Model the idea behind maps of your code.

• C4-PlantUML C4 syntax support for generating plantuml diagrams.

• vscode-plantuml plugin for Visual Studio Code to view diagrams from design time.

Getting started

Requirements

Check out below the requirement to edit, run and build this project:

1. Node & NPM

• Check installation run in your terminal npm -v and node -v

2. C4Builder

• Check installation run in your terminal c4builder

3. Vscode-plantuml Plugin.

Usage

Structure

• To run this project you can choose:

• pt-br: C4Model using Portuguese (Brazilian.)

• en: C4Model using English.

Generating docs files

To generate doc files, run:

c4builder site

Changing configurations

If you want to modify any configuration access:

1. .c4builder file on en/.c4builder or pt-br/.c4builder

Documentation

You can find Beagle's documentation on our website.

Contributing

Feel free to use, recommend improvements or contribute to new implementations.

Check out our contributing guide to learn about our development process, how to suggest bug fixes and improvements.

License

Apache License 2.0.

Community

Feel free to reach out to us at:

• GitHub Issues
• If you have any questions or ideas, let's chat in our Zup Open Source Forum.