Merge pull request #1 from github-developer/readme-and-architecture

imjohnbo · web-flow · commit f8dc5386be63 · 2019-11-27T13:25:15.000-05:00
Add updated README and ARCHITECTURE
diff --git a/.aws/ARCHITECTURE.md b/.aws/ARCHITECTURE.md
@@ -0,0 +1,10 @@
+# High-level architecture
+
+![](ARCHITECTURE.png)
+
+For more information about these services, please see:
+
+1. [Amazon ECS - Run containerized applications in production](https://aws.amazon.com/ecs/)
+1. [AWS Lambda – Serverless compute](https://aws.amazon.com/lambda/)
+1. [Amazon DynamoDB - Fast and flexible NoSQL database service for any scale](https://aws.amazon.com/dynamodb/)
+1. [Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html)
diff --git a/.aws/ARCHITECTURE.png b/.aws/ARCHITECTURE.png
diff --git a/README.md b/README.md
@@ -1,29 +1,31 @@
 <h1 align="center">:smile_cat:<tt>octochat</tt></h1>
 
+<blockquote align="center">Privately message with your GitHub followers</blockquote>
+
 ## Usage
 
-Build the container:
+<img width="1072" alt="example-octochat" src="https://user-images.githubusercontent.com/27806/69747446-020e6900-110c-11ea-9a4b-41fc59a9bb6f.png">
 
-```shell
-docker build -t octochat .
-```
+[Login with your GitHub account](https://octochat.dev/login) to start messaging privately with your GitHub followers.
 
-Run the container:
+## About
 
-```shell
-./script/server.sh
-```
+This app is intended _for demonstration use only_, and is deployed using [Amazon Web Services](https://aws.amazon.com/). The architecture is explained at a high-level [here](.aws/ARCHITECTURE.md).
 
-## Development usage
+## Development
 
-Build the container:
+Create a `.env` file based on [the included example template](.env.example).
+
+Build a development image from [`Dockerfile.develop`](Dockerfile.develop):
 
 ```shell
 docker build -t octochat -f Dockerfile.develop .
 ```
 
-Run the container:
+Use the included [`server.sh`](script/server.sh) script to run the development server in a container:
 
 ```shell
 ./script/server.sh
 ```
+
+The application will be available at [http://localhost:49160/](http://localhost:49160/).
