Added a "Quick Start" to readme #13
Conversation
|
Just realized reading draft-dejong that there is a version of this app running at https://drinks-unhosted.5apps.com/. I don't think it's this particular version--different drink on splash and different widget (at least visually). I think it's still worthwhile to have the GitHub pages enabled on this repo and have this version hosted from this repo. |
|
This is the official example app, hosted at https://myfavoritedrinks.remotestorage.io/ as well. You've seen that one? |
Ah perferct, no I haven't. That's perfect, so this repo is already hosted somewhere. Yea I think the README just needs to say that then :). I'll change this PR to point at https://myfavoritedrinks.remotestorage.io/ so no need for GitHub pages 👍. |
Yup, and updating it is part of the rs.js release checklist, so that it always comes with the latest version of the library: https://remotestoragejs.readthedocs.io/en/latest/contributing/release-checklist.html |
[1] change to be more generic for other servers than armadietto [2] add reference to https://myfavoritedrinks.remotestorage.io/
README.md
Outdated
| * *tester* being a test username | ||
| * *localhost:8000* is where the *remotestorage* server is responding as per step 2. | ||
|
|
||
| [5] what happens at this point is server specific, OAuth flow should redirect you to onboarding and login |
There was a problem hiding this comment.
Actually, the username and port number, i.e. user address, above is also server-specific, and usually you will have to create a user account first. Maybe it would make sense to declare this entire howto being specific to Armadietto?
README.md
Outdated
| [1] Visit https://myfavoritedrinks.remotestorage.io/ | ||
|
|
||
| * it's this app hosted | ||
| * the app needs to be hosted using a Web server--don't just run [index.html](index.html) from file system |
There was a problem hiding this comment.
| * the app needs to be hosted using a Web server--don't just run [index.html](index.html) from file system | |
| * the app needs to be hosted using a Web server--don't just open [index.html](index.html) from file system |
Just added "Quick Start" to readme.
Thing is, for this PR to make sense, the remotestorage/myfavoritedrinks repo needs its settings changed so that github pages are enabled.