Skip to content

Update system diagram #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 28, 2023
Merged

Update system diagram #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a9cf37b
Add developer Onboarding doc reference
senwang86 Jun 21, 2023
5babad8
Add developer onboarding doc as one section in Developer Manual
senwang86 Jun 23, 2023
dc65376
Merge remote-tracking branch 'upstream/main'
senwang86 Jun 27, 2023
41094c5
Update system architecture diagram
senwang86 Jun 27, 2023
76a529a
Update system arch diagram
senwang86 Jun 27, 2023
a0e68e1
Update system arch diagram
senwang86 Jun 27, 2023
bd40db8
Update onboarding nested list
senwang86 Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/4-developer/Codepod_system_arch.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 17 additions & 14 deletions docs/4-developer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,35 +167,38 @@ Then, you can access the new stack at `http://localhost:8080`.
[Typescript](https://github.com/microsoft/TypeScript)

### Libraries and Frameworks

- [React](https://react.dev/) framework
- [Apollo GraphQL](https://www.apollographql.com/)
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) (scalable state management)
- [Monaco](https://github.com/microsoft/monaco-editor) editor
- [Remirror](https://github.com/remirror/remirror) rich-text editor
- [Material](https://mui.com/core/) UI
- [Nano ID](https://github.com/ai/nanoid/blob/HEAD/README.zh-CN.md) UUID generator
- [Express](https://expressjs.com/)
- [Apollo GraphQL](https://www.apollographql.com/)
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) (scalable state management)
- [Monaco](https://github.com/microsoft/monaco-editor) editor
- [Remirror](https://github.com/remirror/remirror) rich-text editor
- [Material](https://mui.com/core/) UI
- [Nano ID](https://github.com/ai/nanoid/blob/HEAD/README.zh-CN.md) UUID generator
- [Express](https://expressjs.com/)
- [Jupyter](https://jupyter-client.readthedocs.io/en/stable/messaging.html)
- [ZeroMQ](https://github.com/zeromq/zeromq.js) Node.js bindings
- [ZeroMQ](https://github.com/zeromq/zeromq.js) Node.js bindings
- [Docker](https://docs.docker.com/compose/compose-file/)
- [Kubernetes](https://kubernetes.io/docs/concepts/overview/)
- [Helm](https://github.com/helm/helm) Chart
- [Helm](https://github.com/helm/helm) Chart
- Proxy configuration: [NGINX](https://github.com/nginx/nginx)
- Database: [PostgreSQL](https://www.postgresql.org/) + [Prisma](https://github.com/prisma/prisma)

### Codepod System Architecture

![System arch](./Codepod_system_arch.png)

### Codepod GitHub Repo

- Frontend
- [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)
- [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)

- Backend
- [Proxy](https://github.com/codepod-io/codepod/tree/main/proxy): reverse proxy server, it forwards/redirects client requests to proper servers in the backbone.
- [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.
- [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.
- [Proxy](https://github.com/codepod-io/codepod/tree/main/proxy): reverse proxy server, it forwards/redirects client requests to proper servers in the backbone.
- [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.
- [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.

### References

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