refactor(README): 更新项目描述和特性列表

更改README文件，反映项目名称为“django-project-template”并列出项目模板的特性。
这包括账户界面美化、三方登录、后台管理界面美化、API开发集成和JWT认证。
还提到了附加的项目结构优化和配置，如templates和locale文件夹的创建、appIndex应用的添加，以及调试配置。

Author: chaofanat

.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+    // 使用 IntelliSense 了解相关属性。 
+    // 悬停以查看现有属性的描述。
+    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python 调试程序: Django",
+            "type": "debugpy",
+            "request": "launch",
+            "args": [
+                "runserver",
+                "0.0.0.0:8080",
+            ],
+            "django": true,
+            "autoStartBrowser": false,
+            "program": "${workspaceFolder}\\manage.py"
+        }
+    ]
+}

MainConfig/__init__.py

@@ -0,0 +1,48 @@
+#ninjia api
+from typing import Any
+from django.http import HttpRequest
+from ninja.security import HttpBearer
+from ninja_jwt.controller import NinjaJWTDefaultController
+from ninja_jwt.authentication import JWTBaseAuthentication
+from ninja_extra import NinjaExtraAPI
+
+
+
+#jwt 认证器
+from django.contrib.auth import get_user_model
+class JWTTokenUser(HttpBearer,JWTBaseAuthentication):
+    def __init__(self) -> None:
+        super().__init__()
+        self.user_model = get_user_model()
+    def authenticate(self, request: HttpRequest, token: str) -> Any | None:
+        return super().jwt_authenticate(request, token)
+        
+    
+
+
+
+
+
+api = NinjaExtraAPI(auth=JWTTokenUser(),csrf=False,version='1.0.0')
+api.register_controllers(NinjaJWTDefaultController)
+
+
+
+
+####################################   测试api    ###################################################################
+@api.post("/bearer")
+def bearer(request):
+    return {'message': 'hello'}
+
+# @api.get("/add")
+# def add(request, a: int, b: int):
+#     return {"result": a + b}
+
+#####################################################################################################################
+# 注册路由,应用api转发
+api.add_router("/appindex", "appIndex.apis.router")
+
+
+
+
+

MainConfig/apis.py

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

MainConfig/asgi.py

@@ -0,0 +1,195 @@
+"""
+Django settings for  project.
+
+Generated by 'django-admin startproject' using Django 5.1.1.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.1/ref/settings/
+"""
+
+from pathlib import Path
+import os
+
+# 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/5.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-1tccg@!ew+x-!6vc0p1=u5!%plz^%#yj^i)z1b9r6p4qnzx0er"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'simpleui',
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    #bootstrap5
+    "django_bootstrap5",
+    # django-allauth
+    # allauth三方身份认证
+    'allauth',
+    'allauth.account',
+    'allauth.socialaccount',
+    'allauth.socialaccount.providers.github',
+    # app
+    'appIndex',
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    # locale
+    "django.middleware.locale.LocaleMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    # allauth
+    "allauth.account.middleware.AccountMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+
+]
+
+ROOT_URLCONF = "MainConfig.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [os.path.join(BASE_DIR, 'templates')],
+        "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",
+
+                # `allauth` needs this from django
+                'django.template.context_processors.request',
+            ],
+            
+        },
+    },
+]
+
+WSGI_APPLICATION = "MainConfig.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.1/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.1/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",
+    },
+]
+
+
+AUTHENTICATION_BACKENDS = [
+
+    # Needed to login by username in Django admin, regardless of `allauth`
+    'django.contrib.auth.backends.ModelBackend',
+
+    # `allauth` specific authentication methods, such as login by email
+    'allauth.account.auth_backends.AuthenticationBackend',
+
+]
+
+# Provider specific settings
+SOCIALACCOUNT_PROVIDERS = {
+    'github': {
+        'SCOPE': ['user', 'repo']
+        
+    },
+}
+
+#认证登录后跳转
+LOGIN_REDIRECT_URL = "/"
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.1/topics/i18n/
+
+from django.utils.translation import gettext_lazy as _
+LANGUAGE_CODE = "zh-hans" # 默认使用中国时区
+
+LOCALE_PATHS = (os.path.join(BASE_DIR, "locale"),)
+
+LANGUAGES = (
+("en", _("English")),
+("zh-hans", _("Simplified Chinese")),
+)
+
+TIME_ZONE = "Asia/Shanghai"
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.1/howto/static-files/
+
+STATIC_URL = "static/"
+
+STATICFILES_DIRS = [
+    os.path.join(BASE_DIR, "static"),
+]
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+
+# email
+#邮件配置,需要去三方邮箱开启授权服务
+# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
+EMAIL_HOST = 'smtp.qq.com'  # 如果是 163 改成 smtp.163.com
+EMAIL_PORT = 465
+EMAIL_HOST_USER = '[email protected]'  # 发送邮件的邮箱帐号
+EMAIL_HOST_PASSWORD = 'ndwuijbugjxnbagc'  # 授权码,各邮箱的设置中启用smtp服务时获取
+DEFAULT_FROM_EMAIL = EMAIL_HOST_USER  #收件人显示发件人的邮箱
+# DEFAULT_FROM_EMAIL = '<[email protected]>' #也可以随意写
+EMAIL_USE_SSL = True   # 使用ssl
+# EMAIL_USE_TLS = False # 使用tls
+# EMAIL_USE_SSL 和 EMAIL_USE_TLS 是互斥的，即只能有一个为 True
+
+

MainConfig/settings.py

@@ -0,0 +1,30 @@
+"""
+URL configuration for  project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.1/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
+from django.urls import include
+from .apis import api
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path('accounts/', include('allauth.urls')),
+    path("i18n/", include("django.conf.urls.i18n")),
+    path('api/', api.urls),
+    path("", include(("appIndex.urls","appIndex"), namespace="appIndex"))
+]
+
+

MainConfig/urls.py

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

MainConfig/wsgi.py

@@ -1,2 +1,22 @@
-# FlashCards
-一个基于django的创建闪卡集、分享闪卡集、闪卡学习的网站
+# django-project-template
+
+一个django项目启动模板。
+
+集成了django-allauth、django-allauth-bootstrap5、simpleui、django-ninja、django-ninja-jwt等django适配的应用，用于提供一个基础设施更加完善的django项目启动模板。
+
+项目模板功能
+
+- [X] 账户相关功能界面美化。基于django-allauth-bootstrap5。
+- [X] 三方登录集成。基于django-allauth。
+- [X] 后台管理界面美化。基于simpleui。
+- [X] api开发集成。基于django-ninja。
+- [X] api登录JWT认证。基于django-ninja-jwt.
+
+
+其他：
+
+* [X] 建立了templates文件夹，用于管理所有前端页面。
+* [X] 建立了locale文件夹，用于管理项目语言本地化。
+* [X] 建立appIndex应用，作为项目初始主页以及示例。
+* [X] 配置vscode调试launch.json文件
+* [X] 完成了三方适配应用的相关开箱即用的初始配置。

README.md

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.