Merge pull request #307 from DefangLabs/more-django-fixes

More fixes for Django Postgres sample

Author: raphaeltm

.devcontainer/Dockerfile

@@ -0,0 +1 @@
+FROM mcr.microsoft.com/devcontainers/python:3.12-bookworm

.devcontainer/devcontainer.json

@@ -0,0 +1,11 @@
+{
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": ".."
+  },
+  "features": {
+    "ghcr.io/defanglabs/devcontainer-feature/defang-cli:1.0.4": {},
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/aws-cli:1": {}
+  }
+}

.github/workflows/deploy.yaml

@@ -0,0 +1,27 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    environment: playground
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@v4
+
+    - name: Deploy
+      uses: DefangLabs/[email protected]
+      with:
+        config-env-vars: POSTGRES_PASSWORD SECRET_KEY ALLOWED_HOSTS
+      env:
+        POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
+        SECRET_KEY: ${{ secrets.SECRET_KEY }}
+        ALLOWED_HOSTS: ${{ secrets.ALLOWED_HOSTS }}

README.md

@@ -0,0 +1,81 @@
+# Django & Postgres
+
+[![1-click-deploy](https://defang.io/deploy-with-defang.png)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-django-postgres-template%26template_owner%3DDefangSamples)
+
+This template is a customer relationship management list project developed using Python Django framework, offering a starting point to help you quickly build your customer management system. We use PostgreSQL as the database. We have prepared all the essential files for deployment. By spending less than 10 minutes setting up the environment, as detailed in the prerequisites, and executing the commands in our step-by-step guide, your website will be ready to go live to the world!
+
+## Prerequisites
+
+1. Download [Defang CLI](https://github.com/DefangLabs/defang)
+2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
+3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
+
+## Development
+
+To run the application locally, you can use the following command:
+
+```bash
+docker compose up --build
+```
+
+## Configuration
+
+For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration): 
+
+> Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.
+
+### `POSTGRES_PASSWORD` 
+
+The password for the PostgreSQL database.
+
+```bash
+defang config set POSTGRES_PASSWORD
+```
+
+### `SECRET_KEY` 
+
+The secret key is used to secure the Django application.
+
+```bash
+defang config set SECRET_KEY
+```
+
+### `ALLOWED_HOSTS` 
+
+The allowed hosts for the Django application. (i.e. the domain your app runs on)
+
+```bash
+defang config set ALLOWED_HOSTS
+```
+
+## Deployment
+
+> [!NOTE]
+> Download [Defang CLI](https://github.com/DefangLabs/defang)
+
+### Defang Playground
+
+Deploy your application to the Defang Playground by opening up your terminal and typing:
+```bash
+defang compose up
+```
+
+### BYOC (AWS)
+
+If you want to deploy to your own cloud account, you can use Defang BYOC:
+
+1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and check that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
+2. Run in a terminal that has access to your AWS environment variables:
+    ```bash
+    defang --provider=aws compose up
+    ```
+
+---
+
+Title: Django & PostgreSQL
+
+Short Description: A customer relationship management list project developed using the Python Django framework, offering a starting point to help you quickly build your customer management system.
+
+Tags: Django, PostgreSQL, Python, SQL
+
+Languages: python

app/.dockerignore

@@ -0,0 +1,32 @@
+# Ignore version control directories
+.git
+.gitignore
+
+# Ignore all bytecode
+*.pyc
+__pycache__/
+
+# Ignore various log and data directories that are created while running locally
+logs/
+data/
+
+# Ignore virtual environment directories
+virt/
+
+# Ignore test, documentation, and CI configuration
+tests/
+docs/
+*.md
+.circleci/
+.travis.yml
+.gitlab-ci.yml
+
+# Ignore PostgreSQL specific files
+*.sql
+*.dump
+
+# Ignore other unnecessary files
+*.log
+*.tar.gz
+*.zip
+tmp/

app/.gitignore

@@ -0,0 +1,135 @@
+tmp
+
+# Django #
+*.log
+*.pot
+*.pyc
+__pycache__
+db.sqlite3
+media
+
+# Backup files #
+*.bak
+
+# If using celery-beat with pickle as serializer #
+celerybeat-schedule.bak
+
+# PyCharm #
+.idea/
+
+# VS Code #
+.vscode/
+
+# Python #
+*.py[cod]
+*$py.class
+
+# Distribution / packaging #
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs #
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports #
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations #
+*.mo
+*.pot
+
+# Django stuff #
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff #
+instance/
+.webassets-cache
+
+# Scrapy stuff #
+.scrapy
+
+# Sphinx documentation #
+docs/_build/
+
+# PyBuilder #
+target/
+
+# Jupyter Notebook #
+.ipynb_checkpoints
+
+# IPython #
+profile_default/
+ipython_config.py
+
+# pyenv #
+.python-version
+
+# celery beat schedule file #
+celerybeat-schedule
+
+# SageMath parsed files #
+*.sage.py
+
+# dotenv #
+.env
+
+# virtualenv #
+venv/
+ENV/
+
+# Spyder project settings #
+.spyderproject
+.spyproject
+
+# Rope project settings #
+.ropeproject
+
+# mkdocs documentation #
+/site
+
+# mypy #
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker #
+.pyre/
+
+# pytype static type analyzer #
+.pytype/
+
+# Cython debug symbols #
+cython_debug/
+
+# Profiling data #
+.prof
+
+# Ignore the static files
+staticfiles/

app/Dockerfile

@@ -0,0 +1,27 @@
+# Use an official Python runtime as a parent image
+FROM python:3.11-slim
+
+RUN apt-get update -qq \
+  && apt-get install -y curl \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/*
+
+# Set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# Set work directory
+WORKDIR /code
+
+# Install dependencies
+COPY ./requirements.txt .
+RUN pip install -r requirements.txt
+
+# Copy project
+COPY . /code/
+
+# Collect static files
+RUN python manage.py collectstatic --noinput
+
+# Start server
+CMD python manage.py migrate && python manage.py createsuperauto && gunicorn app.wsgi:application --bind 0.0.0.0:8000

app/app/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for 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/5.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'app.settings')
+
+application = get_asgi_application()