Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Added a "Quick Start" to readme #13

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

Added a "Quick Start" to readme #13

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7eb6a5c
Update README.md
JakubNer Apr 1, 2019
46fdf5f
Update README.md
JakubNer Apr 9, 2019
386789a
Update README.md
JakubNer Apr 9, 2019
6df34c9
Added reference to https://drinks-unhosted.5apps.com/
JakubNer Apr 9, 2019
2489c13
Change to be more generic for other servers
JakubNer Apr 10, 2019
1b27572
refer to existing getting started docs
michielbdejong Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,40 @@
This is a demo app for [remoteStorage.js](http://remotestorage.io/integrate/).

# Quick Start

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

Choose a reason for hiding this comment

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

Suggested change
* 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


[2] Start a remotestorage server

* there are [many options](https://wiki.remotestorage.io/Servers)

> If using node/npm ecosystem:
>
> 1. clone https://github.com/remotestorage/armadietto
> 1. cd $armadietto
> 1. npm install
> 1. npm run dev

[3] Click on the *remotestorage* widget (logo)

[4] type in `tester@localhost:8000` in the input field of the widget, click through

* *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?


> If using node/npm ecosystem ([armadietto](https://github.com/remotestorage/armadietto) (as per step 2)):
>
> 1. the login page should show up
> 1. register your new *tester* user
> 1. click *#* in the upper right corner
> 1. type in `tester@acme.com` as a fake email
> 1. type in some password
> 1. click through
> 1. back out into the app
> * sorry, no redirect when registering
> * there is a nice *oauth* redirect when just logging in an already registered user