Update docker and readme

trknhr · Jul 10, 2019 · 03308e8 · 03308e8
1 parent f75b1a1
commit 03308e8
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -2,26 +2,33 @@
 
 [![Build Status](https://travis-ci.org/1984weed/akka-http-realworld-example.svg?branch=master)](https://travis-ci.org/1984weed/akka-http-realworld-example)
 
+PRs and issues welcome!
+
 # Getting started
 
-```
-git clone https://github.com/1984weed/akka-http-realworld-example
-```
+1. Clone this repo
+    ```
+    git clone https://github.com/1984weed/akka-http-realworld-example
+    ```
+2. Launch local Database using dokcer-compose
+    ```
+    docker-compose up
+    ```
+3. `sbt run` to start the local server
 
-```
-sbt run
-```
+It launches on `localhost:9000`
 
+# Application Structure
 
-It launches on `localhost:9000`
+Each directory under the realworld.com/ has a responsibility for each Domail. (e.g `articles` has only a responsibility for article router, logic and Database
 
-# Development
+# Main Dependencies
 
-Server Run 
+- Slick3
+- circe
+- Flyway
 
-```
-sbt run
-```
+# Development
 
 Hot reloading 
 
@@ -35,3 +42,9 @@ sbt ~reStart
 sbt scalafmt
 ```
 
+# Licence
+Copyright
+Copyright (C) 2019 Teruo Kunihiro.
+Distributed under the MIT License.
+
+
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -9,6 +9,8 @@ services:
     restart: always
     environment:
       POSTGRES_PASSWORD: postgres
+      POSTGRES_USER: postgres
+      POSTGRES_DB: real_world_dev
     ports:
       - 5432:5432
     volumes: