Skip to content

Commit 0bdd3e7

Browse files
authored
update docs for changing port to :8080 (#352)
1 parent 6f8397e commit 0bdd3e7

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

website/docs/4-developer/README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ docker compose up -d
6464
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).
6565

6666
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.
6868

69-
- `http://localhost:80/graphql`: Apollo GraphQL explorer for the backend APIs
69+
- `http://localhost:8080/graphql`: Apollo GraphQL explorer for the backend APIs
7070
- `http://prisma.127.0.0.1.sslip.io`: Prisma Studio for viewing and debugging the database.
7171

7272
### Initializing database tables
@@ -130,8 +130,8 @@ Because Docker uses the folder name as the default suffix in container names, th
130130
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:
131131

132132
```yaml
133-
listen 80;
134-
listen [::]:80;
133+
listen 8080;
134+
listen [::]:8080;
135135
```
136136

137137
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
140140
nginx:
141141
image: nginx:alpine
142142
ports:
143-
- 80:80
143+
- 8080:8080
144144
volumes:
145145
- ./nginx.conf:/etc/nginx/conf.d/default.conf
146146
```
147147

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.
149149

150150
Also, comment out the port section of the `ui` container in `CODEPOD_ROOT/compose/dev/compose.yml` as:
151151

@@ -169,18 +169,18 @@ Then, you can access the new stack at `http://localhost:8080`.
169169
### Libraries and Frameworks
170170

171171
- [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)
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/)
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/)
179179
- [Jupyter](https://jupyter-client.readthedocs.io/en/stable/messaging.html)
180-
- [ZeroMQ](https://github.com/zeromq/zeromq.js) Node.js bindings
180+
- [ZeroMQ](https://github.com/zeromq/zeromq.js) Node.js bindings
181181
- [Docker](https://docs.docker.com/compose/compose-file/)
182182
- [Kubernetes](https://kubernetes.io/docs/concepts/overview/)
183-
- [Helm](https://github.com/helm/helm) Chart
183+
- [Helm](https://github.com/helm/helm) Chart
184184
- Proxy configuration: [NGINX](https://github.com/nginx/nginx)
185185
- Database: [PostgreSQL](https://www.postgresql.org/) + [Prisma](https://github.com/prisma/prisma)
186186

@@ -191,12 +191,13 @@ Then, you can access the new stack at `http://localhost:8080`.
191191
### Codepod GitHub Repo
192192

193193
- 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)
195196

196197
- 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.
200201

201202
### References
202203

0 commit comments

Comments
 (0)