You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/4-developer/README.md
+20-19Lines changed: 20 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,9 +64,9 @@ docker compose up -d
64
64
If you this is your first time setting up CodePod, or the database schema has been updated (which you can tell from errors), you will also need to [initalize database tables](#initializing-the-database).
65
65
66
66
Wait a few minutes for the package installation and compilation. Once the `ui` and
67
-
`api` containers are ready, go to `http://localhost:80` to see the app.
67
+
`api` containers are ready, go to `http://localhost:8080` to see the app.
68
68
69
-
-`http://localhost:80/graphql`: Apollo GraphQL explorer for the backend APIs
69
+
-`http://localhost:8080/graphql`: Apollo GraphQL explorer for the backend APIs
70
70
-`http://prisma.127.0.0.1.sslip.io`: Prisma Studio for viewing and debugging the database.
71
71
72
72
### Initializing database tables
@@ -130,8 +130,8 @@ Because Docker uses the folder name as the default suffix in container names, th
130
130
The two stacks also may share the same network ports due to the same configuration files used. To set the ports, search for the following lines in `CODEPOD_ROOT/compose/dev/nginx.conf` (two occurences of the two lines in the file) file of the new stack:
131
131
132
132
```yaml
133
-
listen 80;
134
-
listen [::]:80;
133
+
listen 8080;
134
+
listen [::]:8080;
135
135
```
136
136
137
137
and the following section in the `CODEPOD_ROOT/compose/dev/compose.yml` file of the new stack:
@@ -140,12 +140,12 @@ and the following section in the `CODEPOD_ROOT/compose/dev/compose.yml` file of
140
140
nginx:
141
141
image: nginx:alpine
142
142
ports:
143
-
- 80:80
143
+
- 8080:8080
144
144
volumes:
145
145
- ./nginx.conf:/etc/nginx/conf.d/default.conf
146
146
```
147
147
148
-
and replace the default port number 80 to a new port number. For example, you can set the port number to 8080 for all occurences of 80.
148
+
and replace the default port number 8080 to a new port number. For example, you can set the port number to 8081 for all occurences of 8080.
149
149
150
150
Also, comment out the port section of the `ui` container in `CODEPOD_ROOT/compose/dev/compose.yml` as:
151
151
@@ -169,18 +169,18 @@ Then, you can access the new stack at `http://localhost:8080`.
169
169
### Libraries and Frameworks
170
170
171
171
-[React](https://react.dev/) framework
172
-
-[Apollo GraphQL](https://www.apollographql.com/)
173
-
-[Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) (scalable state management)
@@ -191,12 +191,13 @@ Then, you can access the new stack at `http://localhost:8080`.
191
191
### Codepod GitHub Repo
192
192
193
193
- Frontend
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)
194
+
195
+
-[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)
195
196
196
197
- Backend
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.
198
+
-[Proxy](https://github.com/codepod-io/codepod/tree/main/proxy): reverse proxy server, it forwards/redirects client requests to proper servers in the backbone.
199
+
-[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.
200
+
-[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.
0 commit comments