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

Added a "Quick Start" to readme #13

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

JakubNer
Copy link

@JakubNer JakubNer commented Apr 9, 2019

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.

@JakubNer
Copy link
Author

JakubNer commented Apr 9, 2019

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.

@raucao
Copy link
Member

raucao commented Apr 10, 2019

This is the official example app, hosted at https://myfavoritedrinks.remotestorage.io/ as well. You've seen that one?

@JakubNer
Copy link
Author

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 👍.

@raucao
Copy link
Member

raucao commented Apr 10, 2019

That's perfect, so this repo is already hosted somewhere.

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/
Copy link
Member

@raucao raucao left a comment

Choose a reason for hiding this comment

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

Sorry for the long wait! I had a look just now, and added a comment.

* *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
Copy link
Member

Choose a reason for hiding this comment

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

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants