Merge pull request #29 from fasouto/fix/deploy-button-url

Simpilfy home page checklist and update README

Author: fasouto

apps/base/templates/base/home.html

@@ -14,7 +14,7 @@ <h1>Your Django app is running!</h1>
 </div>
 
 <div class="checklist">
-  <h2>Next steps</h2>
+  <h2>Status</h2>
   <ul>
     {% for label, hint, done in checklist %}
     <li class="{% if done %}done{% endif %}">
@@ -26,6 +26,7 @@ <h2>Next steps</h2>
     </li>
     {% endfor %}
   </ul>
+  <p class="hint">To get started, edit <code>apps/base/templates/base/home.html</code></p>
 </div>
 
 <div class="quick-links">

apps/base/views.py

@@ -21,13 +21,10 @@ def home(request):
     secret_changed = secret_key not in ("django-insecure-dev-key-change-me", "build-time-placeholder", "change-me-to-a-random-string")
     rv = '<a href="https://docs.railway.com/variables" target="_blank">Railway variables</a>'
     checklist = [
-        ("Database connected", "Set DATABASE_URL in .env or {}".format(rv), db_ok),
-        ("PostgreSQL configured", "Use postgres:// instead of sqlite:///", db_is_postgres),
+        ("Database", "Set DATABASE_URL in .env or {}".format(rv), db_ok and (db_is_postgres or settings.DEBUG)),
         ("SECRET_KEY changed", "Set a unique key in .env or {}".format(rv), secret_changed),
         ("DEBUG is off", "Set DEBUG=False in production", not settings.DEBUG),
-        ("Set ALLOWED_HOSTS", "Add your domain to ALLOWED_HOSTS in {}".format(rv), not settings.DEBUG and len(settings.ALLOWED_HOSTS) > 0),
-        ("Configure CSRF_TRUSTED_ORIGINS", "Add https://yourdomain to CSRF_TRUSTED_ORIGINS in {}".format(rv), len(settings.CSRF_TRUSTED_ORIGINS) > 0 if hasattr(settings, "CSRF_TRUSTED_ORIGINS") else False),
-        ("Edit this page", "apps/base/templates/base/home.html", False),
+        ("ALLOWED_HOSTS set", "Add your domain to ALLOWED_HOSTS in {}".format(rv), not settings.DEBUG and len(settings.ALLOWED_HOSTS) > 0),
     ]
 
     return render(

config/static/css/base.css

@@ -122,6 +122,21 @@ main { padding: 3rem 0 4rem; }
   color: #fff;
 }
 
+/* Hint */
+.hint {
+  font-size: 0.72rem;
+  color: var(--color-muted);
+  font-family: ui-monospace, SFMono-Regular, "SF Mono", Menlo, monospace;
+  margin-top: 0.75rem;
+  padding-top: 0.75rem;
+  border-top: 1px solid var(--color-border);
+}
+.hint code {
+  background: var(--color-green-light);
+  padding: 0.1em 0.35em;
+  border-radius: 3px;
+}
+
 /* Links */
 .quick-links {
   display: flex;

readme.md

@@ -1,4 +1,8 @@
-# django-starter-template
+<p align="center">
+  <img src="config/static/img/django-pony.png" alt="Django Pony" width="80">
+</p>
+
+<h1 align="center">Django Starter Template</h1>
 
 A production-ready Django 5.2 LTS starter template for [Railway](https://railway.com).
 
@@ -116,16 +120,16 @@ Open [http://localhost:8000](http://localhost:8000). Code changes reload automat
 
 ## What's Included
 
-- **[Django 5.2 LTS](https://docs.djangoproject.com/en/5.2/)** — supported until April 2028
-- **[PostgreSQL](https://www.postgresql.org/)** via psycopg3 — modern async-capable adapter
-- **[WhiteNoise](https://whitenoise.readthedocs.io/)** — serve static files without nginx, with brotli compression
-- **[django-environ](https://django-environ.readthedocs.io/)** — configure via environment variables and `.env` files
-- **[Argon2](https://docs.djangoproject.com/en/5.2/topics/auth/passwords/#using-argon2-with-django)** — password hashing (winner of the Password Hashing Competition)
-- **Split settings** — separate development and production configurations
-- **Health check** — `/health/` endpoint returns JSON for Railway monitoring
-- **[django-debug-toolbar](https://django-debug-toolbar.readthedocs.io/)** — SQL queries, templates, cache inspection (dev only)
-- **[ruff](https://docs.astral.sh/ruff/)** — linting and formatting
-- **[pytest](https://docs.pytest.org/) + [pytest-django](https://pytest-django.readthedocs.io/)** — testing
+- **[Django 5.2 LTS](https://docs.djangoproject.com/en/5.2/)**: supported until April 2028
+- **[PostgreSQL](https://www.postgresql.org/)** via psycopg3, modern async-capable adapter
+- **[WhiteNoise](https://whitenoise.readthedocs.io/)**: serve static files without nginx, with brotli compression
+- **[django-environ](https://django-environ.readthedocs.io/)**: configure via environment variables and `.env` files
+- **[Argon2](https://docs.djangoproject.com/en/5.2/topics/auth/passwords/#using-argon2-with-django)** password hashing (winner of the Password Hashing Competition)
+- **Split settings** for separate development and production configurations
+- **Health check** at `/health/`, returns JSON for Railway monitoring
+- **[django-debug-toolbar](https://django-debug-toolbar.readthedocs.io/)**: SQL queries, templates, cache inspection (dev only)
+- **[ruff](https://docs.astral.sh/ruff/)** for linting and formatting
+- **[pytest](https://docs.pytest.org/) + [pytest-django](https://pytest-django.readthedocs.io/)** for testing
 
 ## Customization
 
@@ -148,4 +152,4 @@ Add `celery[redis]` to your dependencies, create `config/celery.py`, and add a R
 
 ## License
 
-MIT — see [LICENSE](LICENSE).
+MIT. See [LICENSE](LICENSE).