Skip to content
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

Improve development setup docs #1807

Merged
merged 5 commits into from
Dec 3, 2024
Merged

Improve development setup docs #1807

merged 5 commits into from
Dec 3, 2024

Conversation

steffenkleinle
Copy link
Member

Short description

I cleaned up the development setup with new best practices.

Proposed changes

  • Remove duplicated fronted setup documentation
  • Clean up development setup documentation

Side effects

  • None.

Testing

None.

Resolved issues

Fixes: None.

The command has to be run every time a device is connected.

```shell
adb reverse tcp:8081 tcp:8081 && adb reverse tcp:8000 tcp:8000 && adb reverse tcp:5002 tcp:5002
Copy link
Member Author

Choose a reason for hiding this comment

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

This includes port forwarding for integreat as I figured having one command in the history for this makes sense. However, I am also open to keep it entitlementcard only.

Copy link
Contributor

Choose a reason for hiding this comment

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

hm we have the expose:ports that can be triggered via npm run expose:ports i think you should even update this (it also checks for attached devices) and add the command here

@@ -1,4 +1,3 @@
version: "3.5"
Copy link
Member Author

Choose a reason for hiding this comment

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

This is obsolete and led to a warning on startup.
See https://docs.docker.com/reference/compose-file/version-and-name/.

@steffenkleinle steffenkleinle changed the title Improve development setup Improve development setup docs Dec 2, 2024
Copy link
Contributor

@f1sh1918 f1sh1918 left a comment

Choose a reason for hiding this comment

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

Looks good to me

The command has to be run every time a device is connected.

```shell
adb reverse tcp:8081 tcp:8081 && adb reverse tcp:8000 tcp:8000 && adb reverse tcp:5002 tcp:5002
Copy link
Contributor

Choose a reason for hiding this comment

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

hm we have the expose:ports that can be triggered via npm run expose:ports i think you should even update this (it also checks for attached devices) and add the command here

Copy link
Contributor

@seluianova seluianova left a comment

Choose a reason for hiding this comment

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

looks nice 👍

@steffenkleinle steffenkleinle merged commit e897b6e into main Dec 3, 2024
2 checks passed
@steffenkleinle steffenkleinle deleted the development-setup branch December 3, 2024 15:39
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.

3 participants