Skip to content

Commit d8e1f10

Browse files
committed
docs: update README with monorepo structure
Signed-off-by: Quentin Guidée <[email protected]>
1 parent d26a830 commit d8e1f10

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@ Vertex is designed to be installed on low-powered computers like Raspberry Pi, s
3535
- Easy setup on Kubernetes with [Helm Charts](https://github.com/vertex-center/charts)
3636
- _And more to come! (Database, Monitoring, etc)_
3737

38+
## Repository structure
39+
40+
The major part of the Vertex source code is organized as a monorepo.
41+
42+
- [client](https://github.com/vertex-center/vertex/tree/main/client): The web client.
43+
- [docs](https://github.com/vertex-center/vertex/tree/main/docs): The documentation, hosted on [docs.vertex.arra.red](https://docs.vertex.arra.red/).
44+
- [server](https://github.com/vertex-center/vertex/tree/main/server): The server of Vertex.
45+
- [packages](https://github.com/vertex-center/vertex/tree/main/packages)
46+
- [components](https://github.com/vertex-center/vertex/tree/main/packages/components): The shared UI components.
47+
3848
## Installation
3949

4050
> [!NOTE]

0 commit comments

Comments
 (0)