EticaAI/chatops-wg-data#9: added more steps and screenshots

fititnt · Mar 21, 2018 · 3c46587 · 3c46587
1 parent 0268b14
commit 3c46587
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,27 @@
 # kuzzle-playground
 Just testing
 
-## Requisites
+## Step by step
 
-> From http://docs.kuzzle.io/guide/essentials/installing-kuzzle/
+Based on the documentation at http://docs.kuzzle.io/guide/essentials/installing-kuzzle/
 
-1. Docker v1.10+
-2. Docker-compose v1.8+
-3. Maximum virtual memory >= 262144
+> You can see some results at [screenshots/](screenshots/) folder.
+
+1. Requires: Docker v1.10+
+2. Requires: Docker-compose v1.8+
+3. Requires: Maximum virtual memory >= 262144
     - if `sysctl -n vm.max_map_count` is not >= 262144, run `echo "vm.max_map_count=262144" >> /etc/sysctl.conf`
-4. `docker-compose up`
+4. Execute `docker-compose up` on this same repository folder (already downloaded docker-compose.yml)
     - Expected response on initialization process:  _kuzzle_1         | [✔] Kuzzle server ready_
-    - This command shoud return a JSON result `curl "http://localhost:7512/?pretty"`
+    - This command shoud return a JSON result `curl "http://localhost:7512/?pretty"`
+5. `ngrok http 7512` (Note: Use free account from https://ngrok.com, and install Ngrok on your system)
+6. Go to http://kuzzle-backoffice.netlify.com/ and configue the server with ngrok public URL
+7. Go to http://docs.kuzzle.io/guide/essentials/persisted/
+8. Do a POST request to URL http://localhost:7512/myindex/_create (Note: you can a great GUI for this, https://www.getpostman.com/)
+9. Do a PUT request to URL http://localhost:7512/myindex/mycollection
+10. Do a GET request to URL http://localhost:7512/myindex/_list (this list collections)
+11. Do a POST request to http://localhost:7512/myindex/mycollection/_create to create a document with body:
+    - `{  "message": "Hello, world!" }`
+12 Copy the `_id_` from last respose an use on next request instead of xxxxxxxxxxxxxx
+12. Do a POST request to http://localhost:7512/myindex/mycollection/xxxxxxxxxxxxxx/_update to update a document with body:
+    - `{ "message": "in a bottle", "an_englishman": "in New York" }`
diff --git a/screenshots/1-docker-compose.png b/screenshots/1-docker-compose.png
diff --git a/screenshots/2-ngrok.png b/screenshots/2-ngrok.png
diff --git a/screenshots/3-kuzzle-backoffice.png b/screenshots/3-kuzzle-backoffice.png
diff --git a/screenshots/4-kuzzle-backoffice-loggedin.png b/screenshots/4-kuzzle-backoffice-loggedin.png
diff --git a/screenshots/5-guide-essentials-persisted--POST.png b/screenshots/5-guide-essentials-persisted--POST.png
diff --git a/screenshots/6-guide-essentials-persisted-PUT.png b/screenshots/6-guide-essentials-persisted-PUT.png
diff --git a/screenshots/7-guide-essentials-persisted-GET(list-collections).png b/screenshots/7-guide-essentials-persisted-GET(list-collections).png
diff --git a/screenshots/8-guide-essentials-persisted-POST(created-document).png b/screenshots/8-guide-essentials-persisted-POST(created-document).png
diff --git a/screenshots/9-guide-essentials-persisted-POST(update-document) b/screenshots/9-guide-essentials-persisted-POST(update-document)