From f2a5c61257cb49afb80cc0f739d188974634a9f0 Mon Sep 17 00:00:00 2001
From: Timur Demin <me@tdem.in>
Date: Sat, 26 Oct 2019 22:38:44 +0500
Subject: [PATCH] Add build instructions (fixes #19)

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index d1a0f87..f8a4392 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,36 @@
 The web client for [Project Amber](/tdemin/amber), made with React,
 Redux, and TypeScript.
 
+#### Running the app locally
+
+###### Development
+
+Simply run:
+
+    % yarn install --dev
+    % yarn start
+
+Set the `REACT_APP_APIURI` environment variable in case you're testing against
+a local server. It should point to the base URI for all API requests, namely
+`https://amber.h.tdem.in/api`.
+
+###### Docker
+
+Run:
+
+    % docker build . -t amber_web
+    % docker run -it -p 8080:80 amber_web
+
+If you're running your own API server, be sure to set the
+`REACT_APP_APIURI` flag when building:
+
+    % docker build . -t amber_web --build-arg REACT_APP_APIURI=https://your.tld/api
+
+#### Development
+
+The source code of this app is formatted automatically with Prettier. Be sure
+to run `yarn beautify` and `yarn lint` before sending a pull request!
+
 #### License
 
 This program is MIT-licensed. See [LICENSE.txt](LICENSE.txt) for details.