🚀 Best Practices for Structuring a Django Project

Are you struggling to organize your Django projects? 😓 Let’s make your life easier! In this article, I’ll introduce you to a Django boilerplate 🛠️ that follows industrial standards ✅. Say goodbye to messy structures and hello to building amazing features faster! ✨

👉 Check out my boilerplate on Linkedin

🌟 Why Use This Boilerplate?

• Saves time 🕒
• Simplifies project management 📂
• Impresses peers and collaborators 🎉 (yes, my students love it!)

In this guide, we’ll cover:
1️⃣ Setting up a Virtual Environment 🌐
2️⃣ Creating a Django Project 📦
3️⃣ Managing Dependencies 📜
4️⃣ Optimizing Settings ⚙️
5️⃣ Structuring Django Apps 🏗️
6️⃣ Using Makefile for Command Shortcuts 🖱️

1️⃣ Start with a Virtual Environment (VE)

Why use a virtual environment? 🌱

• Keeps dependencies isolated 🔒
• Avoids polluting the global package list 🧹
• Reduces the risk of breaking other projects 💥

🛠️ Steps to Create a VE

python3 -m venv .venv --prompt django-first

Activate it:

source .venv/bin/activate

Install Django:

pip install Django

Why is this important? A virtual environment ensures your Django project is clean, secure, and manageable. 🧼

2️⃣ Creating Your Django Project

Run this command to create a new Django project without unnecessary nested folders:

django-admin startproject config .

🌟 Best Practice

Instead of this messy structure:

project
├── project
│ ├── settings.py
│ └── urls.py

Use this streamlined version:

project  
├── config  
│   ├── settings.py  
│   └── urls.py

Clean, right? 😍

3️⃣ Manage Dependencies Like a Pro 🤓

Create separate requirements files for different environments (e.g., development, production).

Example structure:

requirements/  
├── base.txt  
├── dev.txt

🛠️ Example Content:

base.txt:

Django~=5.0  
django-environ==0.11.2

dev.txt:

-r base.txt  
ipython==8.18.1  
django-extensions==3.2.3

📌 Tip: Use -r base.txt in environment-specific files to avoid duplications!

4️⃣ Optimizing Settings for Scalability ⚙️

Split your settings into multiple files:

• base.py: Common settings 🛠️
• dev.py: Development-specific settings 🌱

Example structure:

config/  
├── settings/  
│   ├── base.py  
│   └── dev.py

This modular approach keeps your project organized and scalable. 📈

5️⃣ Organize Django Apps Like a Boss 🏗️

Instead of cluttering your root folder, group your apps under an apps/ directory.

Run:

mkdir apps  
cd apps  
python3 ../manage.py startapp <app-name>

💡 Core App Tip

Create reusable code for shared functionality (e.g., timestamps for models).

Example:

# apps/core/abstracts/models.py  
class CreatedModifiedAbstract(models.Model):  
    created_at = models.DateTimeField(auto_now_add=True)  
    modified_at = models.DateTimeField(auto_now=True)  

    class Meta:  
        abstract = True

6️⃣ Simplify Commands with Makefile 🖱️

Tired of typing long commands? Use a Makefile to create shortcuts!

Example Makefile:

dev-start:  
    python3 manage.py runserver --settings=config.settings.dev  

dev-migrate:  
    python3 manage.py migrate --settings=config.settings.dev

To run your server:

make dev-start

🏁 Conclusion

The Django framework is powerful, but structuring your project poorly can slow you down. 😬 By using this boilerplate and best practices, you’ll:

• Save time ⏳
• Build scalable applications 💡
• Impress your peers 🏆

So, why wait? Start building your next Django masterpiece today! 🚀

Got questions? Drop them in the comments! 💬