mu-team / django-project-template

Common Django project template for MUTeam existing and future projects.

Django Project Template

Common Django project template for MU-Team existing and future projects.

Installation

echo -n "Project name: "   && read PROJECT_NAME
git clone https://github.com/mu-team/django-project-template.git ${PWD}/${PROJECT_NAME}
cd ${PWD}/${PROJECT_NAME}

echo -n "Git user name: "  && read GIT_USER
echo -n "Git user email: " && read GIT_EMAIL
echo -n "Origin url: "     && read ORIGIN

git config --local user.name  ${GIT_USER}
git config --local user.email ${GIT_EMAIL}
git remote set-url origin     ${ORIGIN}

git add .
git commit -m "Initial commit"
git push -u origin master

# after activation python virtualenv
scripts/dev_setup.sh

System requirements

python --version >= 3.4.0

The project template hierarchy

- docker/*                   # all docker integration files, except `.dockerignore`
- requirements/
              / - common.txt # common dependencies for development and production environments
              / - dev.txt    # only for development environment
              / - prod.txt   # only for production environment
- src/
     / - apps/*              # all user-defined apps collect here (via `./manage.py startapp`)
     / - project/*           # all project-wide configuration (settings, urls, etc.) collect here
     / - static/*            # all static sources collect here (js, css, etc.)
     / - templates/*         # all common/non-standard templates collect here
- static/*                   # `./manage.py collectstatic` root directory
- manage.py                  # project controls

Conventions

1. The different settings for the development/production environment are placed in local.example.py with --PLACEHOLDER--. Specific values are specified in local.py. Example: DEBUG = '--DEBUG -' --> DEBUG = True.
2. All user-defined apps must be placed in apps directory. Example: mkdir -p src/apps/core && ./manage.py startapp core src/apps/core.
3. Installed apps must be separated by INSTALLED_APPS, THIRD_PARTY_APPS, PROJECT_APPS. INSTALLED_APPS contains only django core apps.

Docker support

Supported by docker and docker-compose as ready-to-update services. Need to specify -f on each docker-compose or docker command.

docker-compose -f docker/docker-compose.yml up --build
docker-compose -f docker/docker-compose.yml down

Useful scripts

1. Setup development environment from scratch:

scripts/dev_setup.sh