Django Project Setup Automation Script

Overview

This repository contains a Bash script to automate the creation and setup of a Django project. The script handles the creation of the Django project, apps, virtual environment, and basic Docker configuration. It streamlines repetitive setup tasks, making it faster and easier to start new Django projects.

---

Features

1. Django Project Creation

• Automatically creates a Django project by asking for the project name.
• Sets up a virtual environment (venv) and installs dependencies.

2. App Creation

• Prompts to create an initial app (accounts) with:
  • Directory structure for api/v1.
  • Essential files like urls.py, serializers.py, views.py, and more.
• Allows adding multiple apps in a loop with proper URL configuration and addition to INSTALLED_APPS.

3. Docker Integration

• Optionally creates a Dockerfile for containerizing the Django project.
• Optionally generates a docker-compose.yml for quick containerized setup.

4. Intelligent Configurations

• Dynamically updates:
  • INSTALLED_APPS in settings.py.
  • urlpatterns in urls.py with app-specific routes.
• Prevents duplicate entries in settings or URLs.

---

Installation

1. Clone this repository:

   git clone https://github.com/hosseinpk/Django-Project-structure.git

2. Ensure you have the following installed:

   • Python 3.7 or higher.
   • Bash shell (Linux/macOS or Git Bash on Windows).

3. Install required Python packages: Add your Python dependencies in a requirements.txt file (if not already provided).

---

Usage

1. Set permission:

   chmod +x setup_django_project.sh

   or

   chmod +x django_creator_final.sh

2. Run the script:

   source setup_django_project.sh

   or

   source django_creator_final.sh

3. Follow the prompts:

   • Enter the Django project name.
   • Choose whether to create an initial accounts app.
   • Optionally add more apps in a loop.
   • Decide whether to generate a Dockerfile and/or docker-compose.yml.

---

Example Directory Structure

After running the script, your project may look like this:

project_name/
├── accounts/
│   ├── api/
│   │   └── v1/
│   │       ├── serializers.py
│   │       ├── urls.py
│   │       ├── validators.py
│   │       └── views.py
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── migrations/
│   ├── models.py
│   ├── tests.py
│   └── urls.py
├── project_name/
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── manage.py
├── Dockerfile
├── docker-compose.yml
└── requirements.txt

---

Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a feature branch:

   git checkout -b feature-name

3. Commit your changes:

   git commit -m "Add feature description"

4. Push to the branch:

   git push origin feature-name

5. Open a pull request.

---

License

This project is licensed under the MIT License.

---

Feedback

If you encounter any issues or have suggestions, feel free to open an issue or submit a pull request.

Happy coding! 🚀