From 233ac71838e8623eb5f1c56ed59fa6f9591bb118 Mon Sep 17 00:00:00 2001 From: S4NKALP Date: Thu, 27 Nov 2025 21:38:57 +0545 Subject: [PATCH] docs: improve README to clarify project setup steps and folder structures --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2e5d61e..1a55150 100644 --- a/README.md +++ b/README.md @@ -57,23 +57,26 @@ The tool will ask you a few questions: 1. **What structure do you want?** - **Standard**: Classic Django layout with split settings - - **Single Folder**: All apps in one configurable folder (simple and flat) - **Predefined**: Organized with `apps/` and `api/` folders (great for larger projects) - **Unified**: Everything under `core/` and `apps/` (clean and minimal) + - **Single Folder**: All apps in one configurable folder (simple and flat) -2. **Project details**: +2. **Project Setup**: - Where to create it (use `.` for current directory) - - Project name + - Project name (or directory name for Single Folder) + +3. **Database Configuration**: + - Use `DATABASE_URL` (cleaner, recommended) + - Or separate DB variables + - Choose between PostgreSQL or MySQL + +4. **Django Apps** (Standard Structure only): - Whether to use an `apps/` folder - Which apps to create -3. **CI/CD setup** (optional): +5. **CI/CD Pipeline**: - GitHub Actions, GitLab CI, both, or skip it -4. **Database config**: - - Use `DATABASE_URL` (cleaner, recommended) - - Or separate DB variables - That's it! Your project will be ready with everything configured. ## What You Get @@ -150,7 +153,6 @@ myproject/ │ │ ├── serializers.py │ │ └── urls.py │ └── wsgi.py -└── static/ ``` ### Predefined Structure @@ -180,9 +182,13 @@ myproject/ ├── core/ # Django config │ ├── settings/ │ └── urls.py -└── apps/ # Everything else - ├── core/ - └── api/ +└── apps/ # Main application package + ├── admin/ + ├── models/ + ├── serializers/ + ├── views/ + ├── urls/ + └── api/ # API routes ``` ## Development Workflow