Bump lodash.mergewith from 4.6.1 to 4.6.2 in /web-server

README.md

@@ -1,15 +1,60 @@
-# Usage
+# Magda
 
-1. Replace `/Users/kevin/work/src/github.com/kelda-inc/magda-web-server/src`
-   with the path to your magda-web-server repo.
+This repo was originally developed as a test application for
+[Blimp](https://kelda.io/blimp) (a development environment that runs your
+containers in the cloud, while keeping the exact same configuration and
+workflow as Docker Compose).
 
-2. Run `docker-compose up`.
+It contains examples of several useful Docker Compose patterns, such as [Data
+Containers](TODO).
 
-3. Access the app at `localhost:8080`.
+This repo works with `docker-compose up` as well without any modifications.
 
-4. Changes made to Magda are automatically synced.
+## Usage
 
-5. Clean up with `docker-compose down`.
+### Step 1: Clone the repo
 
-Note that you need permissions to pull the Magda images on your laptop. i.e.
-`docker pull gcr.io/magda-221800/magda-web-server:0.0.50-2` should work.
+```shell
+git clone https://github.com/kelda/magda
+cd magda
+```
+
+### Step 2: Setup Blimp (if you want to run docker-compose.yml in the cloud)
+
+```shell
+# Install the Blimp CLI
+curl -fsSL 'https://kelda.io/get-blimp.sh' | sh
+
+# Create an account
+blimp login
+```
+
+### Step 3: Boot the docker-compose.yml
+
+```shell
+blimp up
+```
+
+Or run `docker-compose up` to run it locally.
+
+Both commands boot the `docker-compose.yml`, and sets up the declared volumes
+and localhost tunnels.
+
+![blimp up](./docs/up.gif)
+
+### Step 4: Test a code change
+
+Wait for all the containers to boot. Note that you may see some errors from the
+indexer and registry-api service, but that's fine.
+
+1. View the Magda homepage at [localhost:8080](http://localhost:8080).
+1. View the bug by searching for "Australia". You should see a Syntax Error.
+1. Fix the bug by changing `this_value_is_wrong` on line 104 of
+   `web-server/src/index.js` to `v0`. Once you save, your change will get
+   synced into the container by a host volume. Nodemon will then notice the
+   file change, and restart your code.
+1. Confirm the fix worked by refreshing [the search](http://localhost:8080/search?q=australia).
+
+## Credits
+* This example repo was adapted from code from the official
+[Magda](https://github.com/magda-io/magda) project.