Skip to content

gdsc-upt/django-template-project

Repository files navigation

Django Template Project

Code style Black

This project is intended to provide a nice and comfortable way to start a new project with Django and it's common settings.

Project setup (Windows)

  • Install a database(use only one of these methods):
    1. Bare metal install:
      • download and install PostgreSQL
      • open your database client (such as pgAdmin) and create a user with a password, such as root and password toor
      • create a new database and give it a name (for example template) and set collation to UTF-8
    2. Using Docker (if you have Windows Home edition then install Docker for Win 10 Home):
      • download and install Docker
      • open a CMD or Git Bash Shell and go (change directory / cd) to the database folder of this project
      • run dir in CMD or ls in Git Bash Shell and if you don't see docker-compose.yml file then you're in the wrong directory. Try again...
      • if you see docker-compose.yml file, then run docker network create pdb and then docker-compose up -d
      • open in browser localhost:8085, log in with admin@example.com username and admin password
      • create a new database and give it a name (for example template) and set collation to UTF-8
  • Install Python and make sure to select Add Python 3.9 to PATH when installation wizard appears
  • Copy template.config.yml to config.yml and add your specific configuration. The most important ones are SECRET_KEY, DB_NAME ,DB_PASSWORD
  • Run setup.bat