Skip to content

Commit

Permalink
update docs showing no need for manual port forwarding of Server in G… (
Browse files Browse the repository at this point in the history
#2247)

update docs showing no need for manual port forwarding of Server in GHCodespaces
  • Loading branch information
MrSimonC authored Sep 9, 2024
1 parent 86f4466 commit 8b7b042
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions .devcontainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,12 @@ Checklist:

:warning: **Important for all developers** :warning:

- [ ] Whe you are using the `NODE_ENV=development` the server will not store the configurations you set for security reasons. Please set the proper config on file `.env.development`. The side-effect if you don't, everytime you restart the server, you will be sent to the "Onboarding" page again.
- [ ] When you are using the `NODE_ENV=development` the server will not store the configurations you set for security reasons. Please set the proper config on file `.env.development`. The side-effect if you don't, everytime you restart the server, you will be sent to the "Onboarding" page again.

:warning: **Important for Github Codespaces** :warning:
**Note when using Github Codespaces**

- [ ] When running the "Server" for the first time, it will automatically configure its port to be publicly accessible by default, as this is required for the front end to reach the server backend. To know more, read the content of the `.env` file on the frontend folder about this, and if any issues occur, make sure to manually set the port "Visibility" of the "Server" is set to "Public" if needed. Again, this is only needed for developing on Github Codespaces.

- [ ] When running the "Server" for the first time, its port will be automatically forward, but privately. Read the content of the `.env` file on the frontend folder about this, and make sure the port "Visibility" is set to "Public", so the frontend can reach the backend. Again, this is only needed for developing on Github Codespaces. We appreciate to know if you have a better solution.

**For the Collector:**

Expand Down

0 comments on commit 8b7b042

Please sign in to comment.