django starter

Джанго стартер

Перед тем, как ваш кофе остынет!

Я вложил все свои лучшие практики Django в этот стартовый репозиторий, чтобы вы могли начать строить сразу.

Это поможет вам:

• Запустите тесты и проверку безопасности Django с помощью действий GitHub
• Работайте быстрее с самодокументированием Makefile, адаптированным к Django
• Форматы файлов перед совершением предварительной коммиты
• Получить Python 3.9, Pip, Pipenv и Django, установленные в новой среде
• Работа с .gitignore, адаптированным к разработке Python и Django
• Настроить и связать базу данных Docker Postgres

Использование

1. Клонировать этот репозиторий

git clone https://github.com/victoriadrake/django-starter

2. Установите переменные среды

./env-setup.sh

(Всегда приятно читать сценарии, прежде чем запустить их! Если вы этого не сделаете, спасибо за биткойн.)

3. Установите зависимости

make install , чтобы установить зависимости в виртуальной среде.

Если вы хотите помочь установить Just Django через Pipenv, запустите ./django-setup.sh .

4. Прибыль !!!

Теперь вы можете make dev , чтобы увидеть довольно желанную страницу по http://localhost:8000/ и проверить, что все работает правильно.

Начни строить! Если вы новичок в Django, проверьте их замечательные учебники.

Запустите make help чтобы увидеть, что еще я настроил для вас.

Что и почему

За эти годы, когда я разрабатывал с Django, я создал набор инструментов разработчиков, практики, которые помогают программистам более эффективными, и множество небольших советов и идей, которые облегчают здание с Django.

Я написал о многих из них и хотел, чтобы вам тоже было легче их использовать!

Автоматизация

Вы можете воспользоваться автоматизацией, чтобы освободить разработчиков от необходимости запустить лининг, тесты и другие обычные действия. Использование предварительной коммиты и потоков, таких как действия GitHub, может помочь сохранить вашу кодовую базу, протестированную и проще в разработке.

• Эта предварительная конфигурация помогает форматировать код и документацию, и даже проверить на случайные обязательные учетные данные!
• Я включил действия GitHub для запуска вашего тестового набора и проверки безопасности Django по запросам.

Настройки и среды

Вместо settings.py по умолчанию. Это помогает избежать ошибок неправильной конфигурации!

Вы можете передать файл настроек в качестве аргумента, например, при запуске сервера разработки:

python manage.py runserver --settings=app.settings.local

Команда Makefile make dev использует это. Кстати о ...

Супер полезный макияж

Представьте, что у вас есть очень полезный, специфичный для проекта CLI, который аккуратно помнит все ваши типичные действия для разработки для вас. Например, вместо печати ...

pipenv run coverage run python manage.py test app --verbosity=0 --parallel --failfast

Вы можете просто сделать:

make test

Разве это не лучше? Я так думаю! Проверьте самодокументирование Makefile, чтобы увидеть, как это облегчает другие повседневные действия. (Почему это самодокументирование? Просто тип make help и посмотрите.)

Внося

Есть что добавить? Не стесняйтесь открыть запрос на тягу!