The Ritchie CLI project has been archived by Zup Innovation. It might start again eventually; however, we won't deliver support for now.
Ritchie-CLI 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. Contributing
6. License
7. Community
About
Ritchie CLI is an open source CLI and arbitrary code execution/sharing engine that allows people to easily & quickly create, execute, and/or share automations or any kind of programming code.
For more information, check out Ritchie CLI repository.
Getting Started
This project was created using 4builder to show RitchieCLI'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 time.
Requirements
Check out below the requirement to edit, run and build this project:
1. Node & NPM
- Check installation run in your terminal
npm -vandnode -v
2. C4Builder
- Check installation run in your terminal
c4builder
Usage
Structure
This project has two sections:
- pt-br: C4Model in Portuguese (Brazilian).
- en: C4Model in English.
Generating docs files
c4builder site
Changing configurations
If you want to modify any configuration access:
.c4builderfile on en/.c4builder or pt-br/.c4builder.
Documentation
You can find Ritchie'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
Community
Feel free to reach out to us at: