Skip to content

Commit

Permalink
edited documenation
Browse files Browse the repository at this point in the history
  • Loading branch information
ji-podhead committed Apr 21, 2024
1 parent 1b0ae6c commit 8d092d7
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 5 deletions.
3 changes: 2 additions & 1 deletion docs/API/README.md
Original file line number Diff line number Diff line change
@@ -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 <img width ="100" align="right" object-fit="contain" src="https://github.com/ji-podhead/protobuffctl/blob/main/docs/protobuffctl.png?raw=true"/>
[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. <br>`The the export module functions do exactly the same`
Expand Down
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -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 <img width ="100" align="right" object-fit="contain" src="https://github.com/ji-podhead/protobuffctl/blob/main/docs/protobuffctl.png?raw=true"/>

Expand Down
File renamed without changes.
58 changes: 56 additions & 2 deletions docs/charts/README.md → docs/architecture/README.md
Original file line number Diff line number Diff line change
@@ -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 <img width ="100" align="right" object-fit="contain" src="https://github.com/ji-podhead/protobuffctl/blob/main/docs/protobuffctl.png?raw=true">
## 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:
┌──────────────────────┐
Expand Down
File renamed without changes.
File renamed without changes.
3 changes: 2 additions & 1 deletion docs/guides/README.md
Original file line number Diff line number Diff line change
@@ -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 <img width ="100" align="right" object-fit="contain" src="https://github.com/ji-podhead/protobuffctl/blob/main/docs/protobuffctl.png?raw=true"/>

Expand Down

0 comments on commit 8d092d7

Please sign in to comment.