Merge pull request #111 from 5haiqin/main-616

Add Django Docs Clone - A Beginner-Friendly Web-Doc

Author: ianshulx

Django-Doc_app/.gitignore

@@ -0,0 +1,72 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+.mypy_cache/
+
+# Django stuff:
+*.log
+local_settings.py
+media
+staticfiles
+
+# SQLite database (unused by this project, but ignore anyway)
+db.sqlite3
+
+# Environments
+.venv/
+venv/
+env/
+ENV/
+
+# IDE/editor
+.vscode/
+.idea/
+*.iml
+
+# OS files
+.DS_Store
+Thumbs.db

Django-Doc_app/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 The django_google_doc_clone Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Django-Doc_app/README.md

@@ -0,0 +1,90 @@
+# Simple Docs Clone — Django Beginner Project
+
+A beginner-friendly Django project that serves a single-page, offline-capable text editor similar to Google Docs. The editor is powered by Quill.js and saves everything to your browser's localStorage. No database is used for documents.
+
+## Features
+- Rich-text editor (bold, italic, underline, strikethrough, headings, size, color, lists, blockquote, code, links, images, undo/redo)
+- Editable document title
+- Autosave to localStorage every 5 seconds and on blur/unload
+- File operations: New, Import (HTML/JSON), Save HTML, Export Markdown, Export PDF, Clear Local Data
+- Live word and character count
+- Responsive, clean UI similar to Google Docs
+- Light/Dark theme with persistence
+- Optional version snapshots (keeps 3 previous saves) with restore
+
+## Tech Stack
+- Python 3.11
+- Django 4.2
+- SQLite (default, unused)
+- HTML5, CSS3, JavaScript (ES6)
+- Frontend via CDN: Quill.js, Turndown.js, html2pdf.js, FontAwesome, Google Fonts (Inter)
+
+## Project Structure
+```
+django_google_doc_clone/
+├─ manage.py
+├─ requirements.txt
+├─ README.md
+├─ LICENSE
+├─ django_google_doc_clone/
+│  ├─ __init__.py
+│  ├─ settings.py
+│  ├─ urls.py
+│  ├─ wsgi.py
+│  └─ asgi.py
+└─ editor/
+   ├─ __init__.py
+   ├─ views.py
+   ├─ urls.py
+   ├─ templates/
+   │  └─ editor/
+   │     └─ index.html
+   └─ static/
+      └─ editor/
+         ├─ css/
+         │  └─ styles.css
+         ├─ js/
+         │  └─ app.js
+         └─ favicon.svg
+```
+
+## Setup
+
+Linux/macOS (bash):
+```
+python -m venv .venv && source .venv/bin/activate
+pip install -r requirements.txt
+python manage.py runserver
+```
+
+Windows (PowerShell):
+```
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+pip install -r requirements.txt
+python manage.py runserver
+```
+
+Open the app at: http://127.0.0.1:8000/
+
+## Using the Editor
+- Title: Click the title at the top to edit.
+- Toolbar: Use the toolbar for formatting (bold, italic, etc.).
+- Autosave: Content and title autosave every 5 seconds and on leaving the page.
+- New: Clears the current document (keeps theme and snapshots).
+- Import: Load an HTML or JSON file. JSON can be a raw Quill Delta or an object with `{ delta, title }`.
+- Save HTML: Downloads a self-contained HTML file with embedded styles.
+- Export Markdown: Converts the current document to .md using Turndown.
+- Export PDF: Creates a PDF via html2pdf.js.
+- Clear Local Data: Removes saved content, title, and snapshots from localStorage.
+- Versions: Keeps the last 3 autosave snapshots. Select one and Restore.
+
+## Deployment
+- Render or PythonAnywhere: Deploy this Django app as usual. Since all logic is client-side, no DB setup is required beyond Django defaults.
+- GitHub Pages: The editor is a static page at `editor/templates/editor/index.html` using static assets at `editor/static/editor/`. You can host it as a pure static site by copying `index.html` and the `static/editor` folder to a static hosting location and replacing `{% load static %}` and `{% static ... %}` with plain relative paths.
+
+## Contributing
+Contributions are welcome! Please fork the repo, create a feature branch, and open a pull request. Beginner-friendly issues are encouraged for Hacktoberfest.
+
+## License
+MIT License — see LICENSE for details.

Django-Doc_app/django_google_doc_clone/asgi.py

@@ -0,0 +1,8 @@
+"""ASGI config for django_google_doc_clone project."""
+
+import os
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_google_doc_clone.settings")
+
+application = get_asgi_application()

Django-Doc_app/django_google_doc_clone/settings.py

@@ -0,0 +1,64 @@
+from pathlib import Path
+
+# Base directory
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-change-me"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ["127.0.0.1", "localhost"]
+
+# Application definition
+INSTALLED_APPS = [
+    "django.contrib.staticfiles",
+    "editor",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "django_google_doc_clone.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [BASE_DIR / "django_google_doc_clone" / "templates"],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.template.context_processors.static",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "django_google_doc_clone.wsgi.application"
+ASGI_APPLICATION = "django_google_doc_clone.asgi.application"
+
+# Database (unused by this project beyond Django defaults)
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+# Internationalization
+LANGUAGE_CODE = "en-us"
+TIME_ZONE = "UTC"
+USE_I18N = True
+USE_TZ = True
+
+# Static files (CSS, JavaScript, Images)
+STATIC_URL = "/static/"
+
+# Default primary key field type
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

Django-Doc_app/django_google_doc_clone/templates/404.html

@@ -0,0 +1,25 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>Page not found · Simple Docs</title>
+    <style>
+      :root { --bg: #0b1320; --card:#111827; --text:#e5e7eb; --muted:#9ca3af; --accent:#3b82f6; }
+      html, body { height: 100%; }
+      body { margin:0; display:grid; place-items:center; background:var(--bg); color:var(--text); font-family: system-ui, -apple-system, Segoe UI, Roboto, Inter, Arial, sans-serif; }
+      .card { background: var(--card); padding: 2rem 2.5rem; border-radius: 12px; box-shadow: 0 10px 30px rgba(0,0,0,.4); text-align:center; }
+      a { color: var(--accent); text-decoration: none; font-weight: 600; }
+      h1 { margin: 0 0 .5rem; font-size: 1.6rem; }
+      p { margin: 0 0 1.25rem; color: var(--muted); }
+      .btn { display:inline-block; background: var(--accent); color:white; padding:.6rem 1.1rem; border-radius:8px; }
+    </style>
+  </head>
+  <body>
+    <div class="card">
+      <h1>404 · Page not found</h1>
+      <p>The page you requested does not exist.</p>
+      <a class="btn" href="/editor/">Go to the Editor</a>
+    </div>
+  </body>
+</html>

Django-Doc_app/django_google_doc_clone/urls.py

@@ -0,0 +1,7 @@
+from django.urls import path, include
+from django.views.generic import RedirectView
+
+urlpatterns = [
+    path("", RedirectView.as_view(url="/editor/", permanent=False), name="root-redirect"),
+    path("editor/", include("editor.urls")),
+]

Django-Doc_app/django_google_doc_clone/wsgi.py

@@ -0,0 +1,8 @@
+"""WSGI config for django_google_doc_clone project."""
+
+import os
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_google_doc_clone.settings")
+
+application = get_wsgi_application()