Skip to content

revise README #334

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.

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 4 commits into from
Jun 20, 2023
Merged

revise README #334

merged 4 commits into from
Jun 20, 2023

Conversation

forrestbao
Copy link
Collaborator

No description provided.

@forrestbao forrestbao requested a review from lihebi June 19, 2023 16:27
@forrestbao forrestbao merged commit e3eebe7 into codepod-io:main Jun 20, 2023

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.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's mention the "development process" somewhere. Basically, the process is:

  1. start the docker stack
  2. modify some .ts files. Upon saving, the server processes will be restarted automatically.
    • How it works:
      • the source files are mounted into the ui/ or api/ container in the development stack.
      • the server process monitor the file changes and restart accordingly
  3. see the changed behavior in app by refreshing the webpage.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future, I plan to remove the "hot-reloading" feature of React (by not binding ui:3000 to localhost:3000) because hot-reloading seems to only update the app partially. A manual refresh is safer and more reliable. Hot reloading is reliable for small apps or style changes, but not a complex app like CodePod. But let's keep it as is for now.

migration, e.g. [this
migration](./api/prisma/migrations/20221206194247_add_google_login/migration.sql).
The schema change along with this migration need to be checked in to git.
- Another developer pulls the change, then running the `npx prisma migrate dev` (in the api container's shell) to apply the schema change.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is useful but got removed.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added back in #363

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants