mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-07-07 17:34:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Introduce a sample project to illustrate setup.

Browse source
This commit is contained in:
Emil Stenström 2022-07-17 08:30:28 +02:00
parent 9d00320aeb
commit 16e2a8dda9
14 changed files with 211 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
sampleproject/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
.python-version
*.sqlite3

0
sampleproject/calendarapp/__init__.py Normal file
View file

6
sampleproject/calendarapp/apps.py Normal file
View file

@ -0,0 +1,6 @@
from django.apps import AppConfig
class CalendarappConfig(AppConfig):
default_auto_field = "django.db.models.BigAutoField"
name = "calendarapp"

0
sampleproject/calendarapp/migrations/__init__.py Normal file
View file

9
sampleproject/calendarapp/templates/calendarapp/calendar.html Normal file
View file

@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
<head>
<title>django_components sample projects</title>
</head>
<body>
Today's date is <span>{{ date }}</span>
</body>
</html>

6
sampleproject/calendarapp/urls.py Normal file
View file

@ -0,0 +1,6 @@
from calendarapp.views import calendar
from django.urls import path
urlpatterns = [
path("", calendar, name="calendar"),
]

13
sampleproject/calendarapp/views.py Normal file
View file

@ -0,0 +1,13 @@
from datetime import datetime
from django.shortcuts import render
def calendar(request):
return render(
request,
"calendarapp/calendar.html",
{
"date": datetime.today(),
},
)

22
sampleproject/manage.py Executable file
View file

@ -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", "sampleproject.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()

1
sampleproject/requirements.txt Normal file
View file

@ -0,0 +1 @@
django

0
sampleproject/sampleproject/__init__.py Normal file
View file

16
sampleproject/sampleproject/asgi.py Normal file
View file

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

115
sampleproject/sampleproject/settings.py Normal file
View file

@ -0,0 +1,115 @@
import os
import secrets
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/4.0/howto/deployment/checklist/
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = os.environ.get("SECRET_KEY", secrets.token_hex(100))
# 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",
"calendarapp",
]
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 = "sampleproject.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 = "sampleproject.wsgi.application"
# Database
# https://docs.djangoproject.com/en/4.0/ref/settings/#databases
DATABASES = {
"default": {
"ENGINE": "django.db.backends.sqlite3",
"NAME": BASE_DIR / "db.sqlite3",
}
}
# Password validation
# https://docs.djangoproject.com/en/4.0/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/4.0/topics/i18n/
LANGUAGE_CODE = "en-us"
TIME_ZONE = "UTC"
USE_I18N = True
USE_TZ = True
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/4.0/howto/static-files/
STATIC_URL = "static/"
# Default primary key field type
# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

5
sampleproject/sampleproject/urls.py Normal file
View file

@ -0,0 +1,5 @@
from django.urls import include, path
urlpatterns = [
path("", include("calendarapp.urls")),
]

16
sampleproject/sampleproject/wsgi.py Normal file
View file

@ -0,0 +1,16 @@
"""
WSGI config for sampleproject 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/4.0/howto/deployment/wsgi/
"""
import os
from django.core.wsgi import get_wsgi_application
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sampleproject.settings")
application = get_wsgi_application()