Skip to content

Added troubleshooting points and clarified SERVER_URL - #17

Open
TheFloatingString wants to merge 2 commits into
masterfrom
feature/documentation
Open

Added troubleshooting points and clarified SERVER_URL#17
TheFloatingString wants to merge 2 commits into
masterfrom
feature/documentation

Conversation

@TheFloatingString

Copy link
Copy Markdown
Collaborator

No description provided.

Comment thread README.md Outdated

Before publishing a new version of the app, make sure to update the
version, minor for feature additions and patch for bug fixes:
version, minor for feature additions and patch (set if changes)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not sure what this means.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I had a typo: I mean patch (which means set of changes), but as you mentioned somewhere else a developer could look up the definition of patch if unfamiliar

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Resolved in the following commit

Comment thread README.md Outdated
If running the Flask backend in parallel with the frontend, the backend URL is
`http://<IP address>:5000`

The IP address can be accessed by the `ifconfig` command for Unix or with `ipconfig`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not only is ifconfig on Linux deprecated (you would use ip route on Linux) but is Linux specific and has nothing to do with "Unix". Since information is very platform specific, I would just say "devices on the local network can access the server using its local IP address". Those who aren't aware of how to find the local IP address can just look it up.

@TheFloatingString TheFloatingString Jan 12, 2020

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Resolved in the following commit

Comment thread README.md Outdated
The IP address can be accessed by the `ifconfig` command for Unix or with `ipconfig`
for Windows. The IP address should look similar to `192.168.x.y` where `x` and `y`
are numbers.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same here, not all networks use 192.168.*.* -- some use 10.0.*.* for example. Saying x and y are numbers is also redundant, since you can assume most people would know that IPv4 addresses consist of four numbers.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I wanted to use 192.168.x.y as an example IP address if someone might be unfamiliar or not sure how it should look like

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Resolved in the following commit

@cherryman

Copy link
Copy Markdown
Member

A little verbose due to self evident information, but otherwise fine if the changes are accomodated.

Comment thread README.md
run
* If command not found in terminal, ensure environment variables
and paths are correctly configured.
* If app on mobile device cannot connect to a localhost backend,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
* If app on mobile device cannot connect to a localhost backend,
* If app on mobile device cannot connect to a server on the local network,

Comment thread README.md
and paths are correctly configured.
* If app on mobile device cannot connect to a localhost backend,
ensure mobile device's Wifi network is the same as the computer
where localhost is running.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
where localhost is running.
where the server is running.

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