Added troubleshooting points and clarified SERVER_URL #17
Conversation
README.md
Outdated
| ## Versioning | ||
|
|
||
| Versions are managed using | ||
| [react-native-version](https://github.com/stovmascript/react-native-version) | ||
| and follow [Semantic Versioning](https://semver.org/). | ||
|
|
||
| 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) |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Resolved in the following commit
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` |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Resolved in the following commit
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. | ||
|
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Resolved in the following commit
|
A little verbose due to self evident information, but otherwise fine if the changes are accomodated. |
| 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, |
There was a problem hiding this comment.
| * 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, |
| 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. |
There was a problem hiding this comment.
| where localhost is running. | |
| where the server is running. |
No description provided.