Documentation: readme and docker-compose (#42)

Author: IceKhan13

README.md

@@ -8,25 +8,22 @@ Platform for tracking, sharing and running quantum experiments in a clean and un
 > Alpha release is in the works. 
 > Files from hackathon project are located in [hackathon folder](./hackathon)
 
-### General overview
-
-![flow](https://raw.githubusercontent.com/IceKhan13/QiskitFlow/master/docs/images/flow.png)
-
-
 ### Hot to run
 * [Overview / Flow](#flow)
-* [Installation](#installation)
+* [Installation and server running](#installation)
 * [Code annotation](#code-annotation)
 * [CLI](#cli)
   * [Experiment runs list](#list-of-experiment-runs)
   * [Experiment run information](#experiment-run-information)
   * [Share experiment](#share-experiment-run)
 * [Examples](#examples)
-* [Run server and UI on your machine](#run-local)
 * [UI](#ui)
 
+
 ### Flow
 
+![flow](https://raw.githubusercontent.com/IceKhan13/QiskitFlow/master/docs/images/flow.png)
+
 Flow of actions while using QiskitFlow is following:
 - [Install](#installation) QiskitFlow if not installed yet
 - [Annotate](#code-annotation) your code with `Experiment` abstraction QiskitFlow library provides
@@ -41,10 +38,24 @@ Flow of actions while using QiskitFlow is following:
 
 ### Installation
 
+In order to install qiskitflow locally you need to follow 2 step process:
+- install python library for code annopatation and cli
+- run docker containers for backend server, ui and database
+
+To install qiskitflow library and CLI simply run
 ```shell script
 pip install qiskitflow
 ```
 
+In order to run containers with required services we suggest to use docker-compose. But by no means we restrict you to deploy qiskitflow to any container aware environment. At the end of the day all required services are just docker images.
+1. Copy [./docker-compose.yaml](docker-compose.yaml file) to your machine
+2. Run `docker-compose up` in a folder where you saved compose file. In a few moments you should see logs from server, ui and database. 
+
+
+> NOTE: in order to share experiments you need to have backend server up and running.
+
+> NOTE: username and password for local server is `admin`
+
 
 ### Code annotation
 
@@ -187,17 +198,6 @@ Experiment information
 [Jupyter notebook with quantum teleportation example](https://github.com/IceKhan13/QiskitFlow/blob/master/docs/examples/example.ipynb)
 
 
-### Run local
-
-0. Install `docker compose` 
-1. Run
-```shell script
-docker-compose up
-```
-
-Note: username and password for local server is `admin`
-
-
 ### UI
 
 <details><summary>Screenshots</summary>

backend/_Dockerfile

@@ -1,5 +1,6 @@
 FROM python:3.7
 ENV PYTHONUNBUFFERED=1
+RUN apt update && apt install postgresql-client -y
 WORKDIR /code
 COPY requirements.txt /code/
 RUN pip install -r requirements.txt

backend/core/management/commands/initadmin.py

@@ -6,7 +6,7 @@
 
 class Command(BaseCommand):
     def handle(self, *args, **options):
-        for line in settings.ADMINS:
+        for line in settings.ON_START_ADMINS:
             username, password, email = line.split(",")
             if User.objects.filter(username=username).exists():
                 print("Admin user {} already exists".format(username))

backend/qiskitflow_backend/settings.py

@@ -166,4 +166,4 @@
     'SLIDING_TOKEN_LIFETIME': timedelta(hours=3)
 }
 
-ADMINS = os.environ.get("DJANGO_ADMINS", "").split(";")
+ON_START_ADMINS = os.environ.get("DJANGO_ADMINS", "").split(";")

docker-compose.yaml

@@ -15,10 +15,7 @@ services:
   server:
     container_name: qiskitflow-server
     image: icekhan/qiskitflow-backend:latest
-    # build: 
-    #   context: ./backend/
-    #   dockerfile: _Dockerfile
-    command: sh -c "python manage.py migrate && python manage.py initadmin && gunicorn qiskitflow_backend.wsgi:application --bind 0.0.0.0:8000"
+    command: sh -c "until pg_isready --username=postgres --host=db; do sleep 1; done; python manage.py migrate && python manage.py initadmin && gunicorn qiskitflow_backend.wsgi:application --bind 0.0.0.0:8000"
     ports:
       - "8000:8000"
     environment:
@@ -37,6 +34,5 @@ services:
   ui:
     container_name: qiskitflow-ui
     image: icekhan/qiskitflow-ui:latest
-    #build: ./ui/
     ports:
       - "3000:80"

docs/images/flow.png

@@ -12,7 +12,7 @@
   <meta name="mobile-web-app-capable" content="yes">
 
   <link rel="icon" href="/favicon.ico" />
-  <title>React.js Boilerplate</title>
+  <title>QiskitFlow. Reproducible quantum experiments.</title>
 </head>
 
 <body>