diff --git a/README.md b/README.md index 0ca4c52..db14a80 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ with Spring framework and a Postgres database. - [`VueJS`](https://github.com/docker/awesome-compose/tree/master/vuejs) - [`Flask`](https://github.com/docker/awesome-compose/tree/master/flask) - [`PHP`](https://github.com/docker/awesome-compose/tree/master/apache-php) +- [`Django`](https://github.com/docker/awesome-compose/tree/master/django) ## Basic setups for different platforms (not production ready - useful for personal use) - [`Gitea / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/gitea-postgres) - [`Nextcloud / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/nextcloud-postgres) diff --git a/django/README.md b/django/README.md new file mode 100644 index 0000000..550ffa2 --- /dev/null +++ b/django/README.md @@ -0,0 +1,52 @@ +## Compose sample application +### Django application in dev mode + +Project structure: +``` +. +├── docker-compose.yaml +├── app +    ├── Dockerfile +    ├── requirements.txt +    └── manage.py + +``` + +[_docker-compose.yaml_](docker-compose.yaml) +``` +services: + web: + build: app + ports: + - '8000:8000' +``` + +## Deploy with docker-compose + +``` +$ docker-compose up -d +Creating network "django_default" with the default driver +Building web +Step 1/6 : FROM python:3.7-alpine +... +... +Status: Downloaded newer image for python:3.7-alpine +Creating django_web_1 ... done + +``` + +## Expected result + +Listing containers must show two containers running and the port mapping as below: +``` +$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +3adaea94142d django_web "python3 manage.py r…" About a minute ago Up About a minute 0.0.0.0:8000->8000/tcp django_web_1 +``` + +After the application starts, navigate to `http://localhost:8000` in your web browser: + +Stop and remove the containers +``` +$ docker-compose down +``` diff --git a/django/app/Dockerfile b/django/app/Dockerfile new file mode 100644 index 0000000..2c645b1 --- /dev/null +++ b/django/app/Dockerfile @@ -0,0 +1,8 @@ +FROM python:3.7-alpine +EXPOSE 8000 +WORKDIR /app +COPY requirements.txt /app +RUN pip3 install -r requirements.txt +COPY . /app +ENTRYPOINT ["python3"] +CMD ["manage.py", "runserver", "0.0.0.0:8000"] diff --git a/django/app/example/__init__.py b/django/app/example/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/django/app/example/settings.py b/django/app/example/settings.py new file mode 100644 index 0000000..72046df --- /dev/null +++ b/django/app/example/settings.py @@ -0,0 +1,129 @@ +""" +Django settings for example project. + +Generated by 'django-admin startproject' using Django 1.11.22. + +For more information on this file, see +https://docs.djangoproject.com/en/1.11/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/1.11/ref/settings/ +""" + +import os + +from environs import Env +from dotenv import load_dotenv +from dotenv import find_dotenv + + +env = Env() +load_dotenv(find_dotenv()) + +# Build paths inside the project like this: os.path.join(BASE_DIR, ...) +BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = env('SECRET_KEY', + 'h8+mu_iy6%5j%7+hp**+gsq$nmy!!mjd8z_qkd94@z!%9%!+qn') + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = env.bool('DEBUG', True) + +ALLOWED_HOSTS = env.list("ALLOWED_HOSTS", ("localhost", "127.0.0.1")) + + +# 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 = 'example.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 = 'example.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/1.11/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), + } +} + + +# Password validation +# https://docs.djangoproject.com/en/1.11/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/1.11/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/1.11/howto/static-files/ + +STATIC_URL = '/static/' diff --git a/django/app/example/urls.py b/django/app/example/urls.py new file mode 100644 index 0000000..0988fcb --- /dev/null +++ b/django/app/example/urls.py @@ -0,0 +1,21 @@ +"""example URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/1.11/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: url(r'^$', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.conf.urls import url, include + 2. Add a URL to urlpatterns: url(r'^blog/', include('blog.urls')) +""" +from django.conf.urls import url +from django.contrib import admin + +urlpatterns = [ + url(r'^admin/', admin.site.urls), +] diff --git a/django/app/example/wsgi.py b/django/app/example/wsgi.py new file mode 100644 index 0000000..c33c08a --- /dev/null +++ b/django/app/example/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for example 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/1.11/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings") + +application = get_wsgi_application() diff --git a/django/app/manage.py b/django/app/manage.py new file mode 100755 index 0000000..72c4bb0 --- /dev/null +++ b/django/app/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +import os +import sys + +if __name__ == "__main__": + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings") + try: + from django.core.management import execute_from_command_line + except ImportError: + # The above import may fail for some other reason. Ensure that the + # issue is really that Django is missing to avoid masking other + # exceptions on Python 2. + try: + import django + except ImportError: + 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?" + ) + raise + execute_from_command_line(sys.argv) diff --git a/django/app/requirements.txt b/django/app/requirements.txt new file mode 100644 index 0000000..705ee21 --- /dev/null +++ b/django/app/requirements.txt @@ -0,0 +1,2 @@ +Django==3.0.5 +environs==7.3.1 \ No newline at end of file diff --git a/django/docker-compose.yml b/django/docker-compose.yml new file mode 100644 index 0000000..111ba72 --- /dev/null +++ b/django/docker-compose.yml @@ -0,0 +1,6 @@ +version: '3.7' +services: + web: + build: app + ports: + - '8000:8000'