Merge pull request #2 from crane-cloud/ch-update-compose-file

chore: update docker-compose file and readme

Author: neelxie

README.md

@@ -1,4 +1,22 @@
 # Database API
 
-To run the application:
-`uvicorn main:app --reload`
+The database API offers a convenient and efficient way to create MySQL and PostgreSQL databases for users on the Crane Cloud platform
+
+# Project Setup
+
+Follow these steps to have a local running copy of the app.
+
+Clone The Repo
+```
+git clone https://github.com/crane-cloud/database-api.git
+```
+
+# Running application with Docker
+
+`make` is a build automation tool that is used to manage the build process of a software project.
+
+In the project directory, running `make` shows you a list of commands to use.
+
+Run `make start` to start the application and required services.
+
+Run `make connect-to-container` to connect to the FastAPI application container.

docker-compose.yml

@@ -1,4 +1,4 @@
-version: "3"
+version: "3.8"
 services:
   database-api:
     restart: always
@@ -9,8 +9,27 @@ services:
     environment:
       PYTHONDONTWRITEBYTECODE: 1
       PYTHONUNBUFFERED: 1
+      DATABASE_USER: postgres
+      DATABASE_URI: ${DATABASE_URI:-postgresql://postgres:postgres@database:5432/cranecloud}
+      TEST_DATABASE_URI: ${TEST_DATABASE_URI:-postgresql://postgres:postgres@database:5432/cranecloud_test}
     ports:
       - "${APP_PORT:-8000}:8000"
     volumes:
       - .:/app
-    
+    depends_on:
+      - database
+
+  database:
+    restart: always
+    image: postgres:10.8-alpine
+    container_name: postgres-database
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: cranecloud
+    ports:
+      - "4200:5432"
+    volumes:
+      - db-data:/var/lib/postgresql/data
+
+volumes:
+  db-data: