Skip to content

Commit c1ba6c6

Browse files
authored
Update system diagram (#10)
1 parent f667aaf commit c1ba6c6

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed
-85.8 KB
Loading

docs/4-developer/README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -167,35 +167,38 @@ Then, you can access the new stack at `http://localhost:8080`.
167167
[Typescript](https://github.com/microsoft/TypeScript)
168168

169169
### Libraries and Frameworks
170+
170171
- [React](https://react.dev/) framework
171-
- [Apollo GraphQL](https://www.apollographql.com/)
172-
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) (scalable state management)
173-
- [Monaco](https://github.com/microsoft/monaco-editor) editor
174-
- [Remirror](https://github.com/remirror/remirror) rich-text editor
175-
- [Material](https://mui.com/core/) UI
176-
- [Nano ID](https://github.com/ai/nanoid/blob/HEAD/README.zh-CN.md) UUID generator
177-
- [Express](https://expressjs.com/)
172+
- [Apollo GraphQL](https://www.apollographql.com/)
173+
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) (scalable state management)
174+
- [Monaco](https://github.com/microsoft/monaco-editor) editor
175+
- [Remirror](https://github.com/remirror/remirror) rich-text editor
176+
- [Material](https://mui.com/core/) UI
177+
- [Nano ID](https://github.com/ai/nanoid/blob/HEAD/README.zh-CN.md) UUID generator
178+
- [Express](https://expressjs.com/)
178179
- [Jupyter](https://jupyter-client.readthedocs.io/en/stable/messaging.html)
179-
- [ZeroMQ](https://github.com/zeromq/zeromq.js) Node.js bindings
180+
- [ZeroMQ](https://github.com/zeromq/zeromq.js) Node.js bindings
180181
- [Docker](https://docs.docker.com/compose/compose-file/)
181182
- [Kubernetes](https://kubernetes.io/docs/concepts/overview/)
182-
- [Helm](https://github.com/helm/helm) Chart
183+
- [Helm](https://github.com/helm/helm) Chart
183184
- Proxy configuration: [NGINX](https://github.com/nginx/nginx)
184185
- Database: [PostgreSQL](https://www.postgresql.org/) + [Prisma](https://github.com/prisma/prisma)
185186

186187
### Codepod System Architecture
188+
187189
![System arch](./Codepod_system_arch.png)
188190

189191
### Codepod GitHub Repo
190192

191193
- Frontend
192-
- [Ui](https://github.com/codepod-io/codepod/tree/main/ui): root folder for Codepod client implementation, it contains the implementation of pod, [Canvas](https://github.com/codepod-io/codepod/blob/main/ui/src/components/Canvas.tsx) and [Scope](https://github.com/codepod-io/codepod/blob/main/ui/src/components/nodes/Scope.tsx)
194+
- [Ui](https://github.com/codepod-io/codepod/tree/main/ui): root folder for Codepod client implementation, it contains the implementation of pod, [Canvas](https://github.com/codepod-io/codepod/blob/main/ui/src/components/Canvas.tsx) and [Scope](https://github.com/codepod-io/codepod/blob/main/ui/src/components/nodes/Scope.tsx)
193195

194196
- Backend
195-
- [Proxy](https://github.com/codepod-io/codepod/tree/main/proxy): reverse proxy server, it forwards/redirects client requests to proper servers in the backbone.
196-
- [Api](https://github.com/codepod-io/codepod/tree/main/api): the API server handles users’ actions on the Codepod client app, it authenticates users, persists the repo, scope and pod states to the Postgres database.
197-
- [Runtime](https://github.com/codepod-io/codepod/tree/main/runtime): Codepod runtime server, http://localhost:4020, this URL is used in the front-end runtime.js to connect to the runtime, it handles the code execution logic on various kernels, e.g., IPython.
197+
- [Proxy](https://github.com/codepod-io/codepod/tree/main/proxy): reverse proxy server, it forwards/redirects client requests to proper servers in the backbone.
198+
- [Api](https://github.com/codepod-io/codepod/tree/main/api): the API server handles users’ actions on the Codepod client app, it authenticates users, persists the repo, scope and pod states to the Postgres database.
199+
- [Runtime](https://github.com/codepod-io/codepod/tree/main/runtime): Codepod runtime server, <http://localhost:4020>, this URL is used in the front-end runtime.js to connect to the runtime, it handles the code execution logic on various kernels, e.g., IPython.
198200

199201
### References
202+
200203
- A tutorial for React-based web application development, [WhatsApp-Clone-Tutorial](https://www.tortilla.academy/Urigo/WhatsApp-Clone-Tutorial/master/next/step/0)
201-
- [Typescript Tutorial](https://github.com/xcatliu/typescript-tutorial)
204+
- [Typescript Tutorial](https://github.com/xcatliu/typescript-tutorial)

0 commit comments

Comments
 (0)