Skip to content

Commit 4e853c2

Browse files
committed
docs: add architecture diagram
1 parent e514aeb commit 4e853c2

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

docs/Architecture.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,9 @@ GitProxy has several main components:
2020
- Routes: All the API endpoints used by the UI and proxy to perform operations and fetch or modify GitProxy's state. Except for custom application development, there is no need for users or GitProxy administrators to interact with the API directly.
2121
- Configuration (`/src/config`): Loads and validates the configuration from `proxy.config.json`, or any provided config file. Allows customising several aspects of GitProxy, including databases, authentication methods, predefined allowed repositories, commit blocking rules and more. For a full list of configurable parameters, check the [config file schema reference](https://git-proxy.finos.org/docs/configuration/reference/).
2222
- UI (`/src/ui`): Allows user-friendly interactions with the application. Shows the list of pushes requiring approval, the list of repositories that users can contribute to, and more. Also allows users to easily review the changes in a push, and approve or reject it manually according to company policy.
23+
24+
## Diagram
25+
26+
These are all the core components in the project, along with some basic user interactions:
27+
28+
![GitProxy Architecture Diagram](./img/architecture.png)

docs/img/architecture.png

171 KB
Loading

0 commit comments

Comments
 (0)