Name Last commit Last update
base_django_project users: hide /me url
compose [Dev] USE_DOCKER variable removed
config [Config] Added examples to aid in imports for external apps
ext-apps External MOOC apps added as Git Submodules
requirements [Prod/Dev] Install submodule applications during all builds
utility Initial version; largely based on the current 'Empurrando Juntos' install
.coveragerc Initial version; largely based on the current 'Empurrando Juntos' install
.dockerignore Initial version; largely based on the current 'Empurrando Juntos' install
.editorconfig Initial version; largely based on the current 'Empurrando Juntos' install
.gitattributes Initial version; largely based on the current 'Empurrando Juntos' install
.gitignore Initial version; largely based on the current 'Empurrando Juntos' install
.gitlab-ci.yml [CI] Explicitly define git strategies for submodules and deploy jobs
.gitmodules External MOOC apps added as Git Submodules
.pylintrc Initial version; largely based on the current 'Empurrando Juntos' install
CONTRIBUTORS.txt Initial version; largely based on the current 'Empurrando Juntos' install
COPYING Initial version; largely based on the current 'Empurrando Juntos' install
LICENSE Initial version; largely based on the current 'Empurrando Juntos' install
README.md [Dev] USE_DOCKER variable removed
docker-compose.yml [Dev] USE_DOCKER variable removed
env.example Initial version; largely based on the current 'Empurrando Juntos' install
manage.py Initial version; largely based on the current 'Empurrando Juntos' install
production.yml Initial version; largely based on the current 'Empurrando Juntos' install
pytest.ini Initial version; largely based on the current 'Empurrando Juntos' install
setup.cfg Initial version; largely based on the current 'Empurrando Juntos' install

Projeto Django Base

Projeto Django baseado no padrão cookiecutter-django e com diversas adaptações para uso na infraestrutura Docker-Rancher do hacklab/.

Ambiente de desenvolvimento

Para clonar este repositório, execute:

git clone git@gitlab.com:hacklab/base-django-project.git

Levante o ambiente de desenvolvimento com docker-compose -f local.yml up e acesse localhost:8000.

Testes

Existem duas maneiras de se executar os testes automatizados localmente:

  • Você já executou o comando docker-compose -f local.yml up e o servidor está funcionando.
docker-compose -f local.yml exec django pytest
  • Você deseja apenas executar os testes sem necessariamente levantar o servidor. Antes é necessário construir a imagem do backend e disponibilizar o banco de dados para então executar o pytest via docker run
docker build -f compose/test/django/Dockerfile -t django_test .
docker run -d --env-file=./compose/test/test_env --name=postgres_test postgres:9.6
docker run --env-file=./compose/test/test_env --link=postgres_test:postgres \
  django_test /test.sh

Variáveis de ambiente

Banco de dados

  • POSTGRES_HOST - opcional; padrão 'postgres'
  • POSTGRES_DB - obrigatório
  • POSTGRES_USER - obrigatório
  • POSTGRES_PASSWORD - obrigatório

Email

  • MAILGUN_SENDER_DOMAIN - obrigatório em produção
  • DJANGO_DEFAULT_FROM_EMAIL - obrigatório em produção
  • DJANGO_MAILGUN_API_KEY - obrigatório em produção

Django

  • DJANGO_ALLOWED_HOSTS - obrigatório em produção
  • DJANGO_ADMIN_URL - opcional
  • DJANGO_SETTINGS_MODULE - opcional; use config.settings.production em produção
  • DJANGO_ACCOUNT_ALLOW_REGISTRATION - opcional; padrão True
  • DJANGO_SECRET_KEY - obrigatório em produção
  • USE_CACHE - opcional; padrão True

Redis

  • REDIS_URL - obrigatório em produção; exemplo: redis://127.0.0.1:6379

Sentry

  • DJANGO_SENTRY_DSN - opcional; só válido em produção

Depoly em produção

Um exemplo de deploy em produção pode ser encontrado no arquivo production.yml.

Para rodá-lo localmente, e assim ter o máximo de aderência com o ambiente final, cire um arquivo .env baseado em env.example com as configurações necessárias e execute:

docker-compose -f production.yml up

Integrações de deploy

Commits no branch master fazem releases da versão em desenvolvimento.

Tags fazem releases em produção.