Django-Postgres application template created (#178)

In this template is shown how to connect Djnago and PostgreSQL using docker-compose servise. 

Signed-off-by: Ulugbek Muslitdinov <ulugbekmuslitdinov@gmail.com>

django-postgres/Dockerfile

@@ -0,0 +1,16 @@
+# Pull base image
+FROM python:3.8
+
+# Set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# Set work directory
+WORKDIR /code
+
+# Install dependencies
+COPY requirements.txt /code/
+RUN pip3 install -r requirements.txt --no-cache-dir
+
+# Copy project
+COPY . /code/

django-postgres/README.md

@@ -0,0 +1,83 @@
+# Compose sample application
+
+## Django application with PostgreSQL support
+
+Project structure:
+```
+.
+├── docker-compose.yml
+├── Dockerfile
+├── requirements.txt
+├── manage.py
+├── django_app
+    ├── settings.py
+    ├── urls.py
+    └── wsgi.py
+```
+
+[docker-compose.yml](https://github.com/docker/awesome-compose/blob/master/django-postgres/docker-compose.yml)
+
+```yaml
+services:
+  web:
+    build: .
+    ports:
+      - 8000:8000
+    depends_on:
+      - db
+  db:
+    image: postgres:11
+    ports:
+      - 5432:5432
+
+volumes:
+  postgres_data:
+```
+
+# Changes in Django project
+To make your Django project work with PostgreSQL, you need to add the following lines to your settings.py file:
+```python
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'postgres',
+        'USER': 'postgres',
+        'PASSWORD': 'postgres',
+        'HOST': 'db',
+        'PORT': 5432
+    }
+}
+```
+
+# Deploy with docker-compose
+```
+$ docker-compose up -d
+[+] Building 27.5s (10/10) FINISHED
+ => [internal] load build definition from Dockerfile  
+ => => transferring dockerfile: 340B
+ ...
+ ...
+ [+] Running 4/4
+ ⠿ Network django-postgres_default         Created                                                                                                     0.1s
+ ⠿ Volume "django-postgres_postgres_data"  Created                                                                                                     0.0s
+ ⠿ Container django-postgres-db-1          Started                                                                                                     2.9s
+ ⠿ Container django-postgres-web-1         Started
+```
+
+
+# Expected result
+Listing containers must showtwo containers running and the port mapping as below:
+```
+$ docker ps
+CONTAINER ID        IMAGE               COMMAND                  CREATED             STATUS              PORTS               NAMES
+9a3b782b1b5a   django-postgres_web   "python /code/manage…"   12 minutes ago   Up 12 minutes   0.0.0.0:8000->8000/tcp   django-postgres-web-1
+de27369602f3   postgres:11           "docker-entrypoint.s…"   12 minutes ago   Up 12 minutes   0.0.0.0:5432->5432/tcp   django-postgres-db-1
+```
+
+After the application starts, navigate to ```http://localhost:8000``` in your web browser.
+
+To stop and remove containers, run:
+```
+$ docker-compose down
+```
+

django-postgres/django_app/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for django_app project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_app.settings')
+
+application = get_asgi_application()

django-postgres/django_app/settings.py

@@ -0,0 +1,129 @@
+"""
+Django settings for django_app project.
+
+Generated by 'django-admin startproject' using Django 3.2.8.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-wz=lazac12szp%asf(4861lt)o3m0e$yj#1)e(%+q%o149z#-p'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'django_app.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'django_app.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/2.2/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'postgres',
+        'USER': 'postgres',
+        'PASSWORD': 'postgres',
+        'HOST': 'db',
+        'PORT': 5432
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/3.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.2/howto/static-files/
+
+STATIC_URL = '/static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

django-postgres/django_app/urls.py

@@ -0,0 +1,21 @@
+"""django_app URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]

django-postgres/django_app/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for django_app project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_app.settings')
+
+application = get_wsgi_application()

django-postgres/docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3.8'
+
+services:
+  web:
+    build: .
+    command: python /code/manage.py runserver 0.0.0.0:8000  # For local development
+#    command: gunicorn config.wsgi -b 0.0.0.0:8000  # For production
+    volumes:
+      - .:/code
+    ports:
+      - 8000:8000
+    depends_on:
+      - db
+  db:
+    image: postgres:11
+    volumes:
+      - postgres_data:/var/lib/postgresql/data/
+    ports:
+      - 5432:5432
+    environment:
+      - "POSTGRES_HOST_AUTH_METHOD=trust"
+
+volumes:
+  postgres_data:

django-postgres/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_app.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

django-postgres/requirements.txt

@@ -0,0 +1,3 @@
+Django==3.2.7
+psycopg2-binary==2.8.4
+environs==7.3.1

vuejs/README.md

@@ -22,7 +22,7 @@ services:
     - ./vuejs:/project
     - /project/node_modules
 ```
-The compose file defines an application with one service `sparkjava`.
+The compose file defines an application with one service `vuejs`.
 When deploying the application, docker-compose maps port 8080 of the web service container to port 8080 of the host as specified in the file.
 Make sure port 8080 on the host is not already being in use.