From 8d092d72a0e0a578f392dca1ede7104a57f6015d Mon Sep 17 00:00:00 2001 From: "J.I. /podhead" <117015142+ji-soft@users.noreply.github.com> Date: Sun, 21 Apr 2024 10:21:22 +0200 Subject: [PATCH] edited documenation --- docs/API/README.md | 3 +- docs/README.md | 3 +- .../Architectual Overview | 0 docs/{charts => architecture}/README.md | 58 ++++++++++++++++++- docs/{charts => architecture}/complete | 0 docs/{charts => architecture}/registry schema | 0 docs/guides/README.md | 3 +- 7 files changed, 62 insertions(+), 5 deletions(-) rename docs/{charts => architecture}/Architectual Overview (100%) rename docs/{charts => architecture}/README.md (71%) rename docs/{charts => architecture}/complete (100%) rename docs/{charts => architecture}/registry schema (100%) diff --git a/docs/API/README.md b/docs/API/README.md index ad1866b6..069b9218 100644 --- a/docs/API/README.md +++ b/docs/API/README.md @@ -1,5 +1,6 @@ - | [About](https://ji-podhead.github.io/protobuffctl/) | [API](https://ji-podhead.github.io/protobuffctl/API) | [CLI Guide](https://ji-podhead.github.io/protobuffctl/guides) | [FlowChart](https://ji-podhead.github.io/protobuffctl/charts) | [Git-Repo](https://github.com/ji-podhead/protobuffctl) | + | [About](https://ji-podhead.github.io/protobuffctl/) | [API](https://ji-podhead.github.io/protobuffctl/API) | [CLI Guide](https://ji-podhead.github.io/protobuffctl/guides) | [Architecture](https://ji-podhead.github.io/protobuffctl/architecture) | [Git-Repo](https://github.com/ji-podhead/protobuffctl) | + ## API [Protobuffctl](https://github.com/ji-podhead/protobuffctl) has a command-line interface (CLI) tool designed to manage components and watchers for a project, possibly related to Protocol Buffers (protobuf). This documentation provides an overview of the available commands and their usage.
`The the export module functions do exactly the same` diff --git a/docs/README.md b/docs/README.md index a61a2992..0866ce94 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,6 @@ - | [About](https://ji-podhead.github.io/protobuffctl/) | [API](https://ji-podhead.github.io/protobuffctl/API) | [CLI Guide](https://ji-podhead.github.io/protobuffctl/guides) | [FlowChart](https://ji-podhead.github.io/protobuffctl/charts) | [Git-Repo](https://github.com/ji-podhead/protobuffctl) | + | [About](https://ji-podhead.github.io/protobuffctl/) | [API](https://ji-podhead.github.io/protobuffctl/API) | [CLI Guide](https://ji-podhead.github.io/protobuffctl/guides) | [Architecture](https://ji-podhead.github.io/protobuffctl/architecture) | [Git-Repo](https://github.com/ji-podhead/protobuffctl) | + # about diff --git a/docs/charts/Architectual Overview b/docs/architecture/Architectual Overview similarity index 100% rename from docs/charts/Architectual Overview rename to docs/architecture/Architectual Overview diff --git a/docs/charts/README.md b/docs/architecture/README.md similarity index 71% rename from docs/charts/README.md rename to docs/architecture/README.md index a632ed46..fd6258c2 100644 --- a/docs/charts/README.md +++ b/docs/architecture/README.md @@ -1,8 +1,62 @@ - | [About](https://ji-podhead.github.io/protobuffctl/) | [API](https://ji-podhead.github.io/protobuffctl/API) | [CLI Guide](https://ji-podhead.github.io/protobuffctl/guides) | [FlowChart](https://ji-podhead.github.io/protobuffctl/charts) | [Git-Repo](https://github.com/ji-podhead/protobuffctl) | + | [About](https://ji-podhead.github.io/protobuffctl/) | [API](https://ji-podhead.github.io/protobuffctl/API) | [CLI Guide](https://ji-podhead.github.io/protobuffctl/guides) | [FlowChart](https://ji-podhead.github.io/protobuffctl/architecture) | [Git-Repo](https://github.com/ji-podhead/protobuffctl) | -## FLow Chart +## Codebase Organization: +**File-Structure:** +``` +├── main.js +├── src/ +│ ├── components.js +│ ├── protoUtils.js +│ ├── protobuffctl.js +│ └── shared.js +├── test/ +│ ├── serverTest.js +│ ├── test.js +│ └── test.proto +├── util/ +│ ├── cli.js +│ ├── middleware.js +│ ├── service_worker.js +│ └── utils.js +└── util/dashboard/ +``` +## Codebase Organization + +This section provides an overview of the project's file structure and the purpose of each file. + +### Main Files + +- `main.js`: This is the main entry point of the application. It initializes the application and sets up the necessary configurations. + +### Source Files + +- `src/`: This directory contains the core source code files. + - `components.js`: Manages the creation and manipulation of Protobuf components such as message types, fields, services, and enums. + - `protoUtils.js`: Contains utility functions for working with Protobuf files, such as parsing and serialization. + - `protobuffctl.js`: The core module that integrates all functionalities of Protobuffctl, including API server, CLI commands, and file generation. + - `shared.js`: Contains shared utilities and constants used across the application. + +### Test Files + +- `test/`: This directory contains test files to ensure the reliability and correctness of the application. + - `serverTest.js`: Tests for the API server and its endpoints. + - `test.js`: General tests for the application's functionalities. + - `test.proto`: Protobuf test files used for testing Protobuf functionalities. + +### Utility Files + +- `util/`: This directory contains utility files that support the application's operations. + - `cli.js`: Implements the command-line interface for Protobuffctl, allowing users to interact with the application through the terminal. + - `middleware.js`: Contains middleware functions for handling requests and responses, ensuring ACID compliance and preventing race conditions. + - `service_worker.js`: Manages background tasks and operations, such as file watching and automatic file generation. + - `utils.js`: General utility functions used throughout the application. + +### Dashboard Files + +- `util/dashboard/`: This directory contains files related to the built-in dashboard for demo, debugging, and testing purposes. +## Flow Chart ``` Architecture: ┌──────────────────────┐ diff --git a/docs/charts/complete b/docs/architecture/complete similarity index 100% rename from docs/charts/complete rename to docs/architecture/complete diff --git a/docs/charts/registry schema b/docs/architecture/registry schema similarity index 100% rename from docs/charts/registry schema rename to docs/architecture/registry schema diff --git a/docs/guides/README.md b/docs/guides/README.md index 1aad941e..c1c04b44 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -1,5 +1,6 @@ - | [About](https://ji-podhead.github.io/protobuffctl/) | [API](https://ji-podhead.github.io/protobuffctl/API) | [CLI Guide](https://ji-podhead.github.io/protobuffctl/guides) | [FlowChart](https://ji-podhead.github.io/protobuffctl/charts) | [Git-Repo](https://github.com/ji-podhead/protobuffctl) | + | [About](https://ji-podhead.github.io/protobuffctl/) | [API](https://ji-podhead.github.io/protobuffctl/API) | [CLI Guide](https://ji-podhead.github.io/protobuffctl/guides) | [Architecture](https://ji-podhead.github.io/protobuffctl/architecture) | [Git-Repo](https://github.com/ji-podhead/protobuffctl) | + ## CLI Guide