The Charles project has been archived by Zup Innovation. It might start again eventually; however, we won't deliver support for now.

Charlescd C4 model

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. Issues

6. Contributing

7. License

8. Community

About

This project was created using 4builder to show CharlesCD's architecture, see below the tools we used:

• PlantUml creates diagrams from plain text.

• 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 team .

Getting started

Requirements

Check out below the requirements 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

This project has two sections:

1. pt-br: C4Model in Portuguese (Brazilian).
2. en: C4Model in English.

Generating docs files

To generate doc files, run: c4builder site

Changing configurations

If you want to modify any configuration access: .c4builder file on en/.c4builder or pt-br/.c4builder.

Documentation

You can find CharlesCD's documentation on our website.

Issues

To open or track an issue for this project, in order to better coordinate your discussions, we recommend that you use the Issues tab in the main CharlesCD repository.

Contributing

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

Check out our CharlesCD 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.

Thank you for evoluting CharlesCD!!!:heart::heart::heart:

Keep evolving 🚀