gdsc-uptgdsc-upt
5

Django Template Project

screenshot of Django Template Project
django

A template to start hacking with Django

Github

Overview

The Django Template Project aims to simplify the process of starting a new project with Django. It provides a comfortable and user-friendly setup with common settings.

Features

  • Easy project setup with common Django settings.
  • Option to choose between a bare metal install or using Docker for Windows.
  • Seamless installation of PostgreSQL database.
  • User-friendly interface with browser access.
  • Customizable configuration options.

Project Setup (Windows)

  1. Install a database:

    • Bare metal install:
      • Download and install PostgreSQL.
      • Open your database client (e.g., pgAdmin) and create a user with a password (e.g., root and password toor).
      • Create a new database and give it a name (e.g., template) and set collation to UTF-8.
    • Using Docker (for Windows Home edition):
      • Download and install Docker.
      • Open a CMD or Git Bash Shell and navigate to the database folder of the project.
      • Run dir in CMD or ls in Git Bash Shell to ensure you're in the correct directory (where docker-compose.yml file is located).
      • If the file is found, run docker network create pdb and then docker-compose up -d.
      • Open your browser and go to localhost:8085. Log in with the username admin@example.com and the password admin.
      • Create a new database and give it a name (e.g., template) and set collation to UTF-8.

  2. Install Python:

    • Download and install Python, making sure to select "Add Python 3.9 to PATH" during the installation wizard.

  3. Configuration:

    • Copy template.config.yml file to config.yml.
    • Open config.yml and add your specific configuration. The most important ones are SECRET_KEY, DB_NAME, and DB_PASSWORD.

  4. Run setup:

    • Run setup.bat to complete the setup process.

Summary

The Django Template Project simplifies the setup process for starting a new project with Django. It offers easy installation options for the database, Docker integration for Windows Home edition, and provides a user-friendly browser interface. The customizable configuration allows users to tailor the project to their specific needs.

django
Django

Django is a high-level Python web framework that encourages rapid development and clean, pragmatic design. It follows the model-view-controller (MVC) architectural pattern, providing an extensive set of built-in tools and conventions to streamline the creation of robust and scalable web applications.

docker
Docker

A website that uses Docker for containerization to streamline development, testing, and deployment workflows. This includes features such as containerization of dependencies, automated builds and deployments, and container orchestration to ensure scalability and availability.