django starter

Entrante de Django

¡Ve de un nuevo entorno a comenzar un proyecto Django antes de que tu café se enfríe!

Puse todas mis mejores prácticas de Django en este repositorio de inicio para que pueda comenzar a construir de inmediato.

Esto te ayudará:

• Ejecutar pruebas y verificación de seguridad de Django a través de acciones de GitHub
• Trabaja más rápido con un Makefile autocompletador a medida para Django
• Formato de archivos antes de comprometerse con el pre-Commit
• Obtenga instalado Python 3.9, Pip, Pipenv y Django en un nuevo entorno
• Trabajar con un .Gitignore adaptado al desarrollo de Python y Django
• Configurar y vincular una base de datos de Docker Postgres

Uso

1. Clon este repositorio

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

2. Establezca sus variables de entorno

./env-setup.sh

(¡Siempre es una buena idea leer los guiones antes de ejecutarlos! Si no lo haces, bueno, gracias por el bitcoin).

3. Instalar dependencias

Haga make install para instalar dependencias en un entorno virtual.

Si desea ayudar a instalar solo django a través de Pipenv, ejecute ./django-setup.sh .

4. Beneficio !!!

Ahora puede make dev para ver una página de muy bienvenida en http://localhost:8000/ y probar que todo funciona correctamente.

¡Empiece a construir! Si eres nuevo en Django, mira sus excelentes tutoriales.

Corree make help para ver qué más me he configurado.

Que y por qué

A lo largo de los años, he estado desarrollando con Django, he creado un conjunto de herramientas de desarrollador, prácticas que ayudan a que los programadores sean más eficientes y muchos pequeños consejos e ideas que facilitan la construcción con Django.

¡He escrito sobre muchos de estos, y quería que fuera más fácil usarlos también!

Automatización

Puede aprovechar la automatización para aliviar a los desarrolladores de tener que recordar ejecutar pelusas, pruebas y otras acciones de rutina. El uso de precomisores y flujos como las acciones de GitHub puede ayudar a mantener su base de código consistente, probada y más fácil de desarrollar.

• ¡Esta configuración previa al compromiso ayuda a formatear el código y la documentación, e incluso verificar las credenciales comprometidas accidentalmente!
• He incluido acciones de GitHub para ejecutar su suite de prueba y la verificación de seguridad de Django en las solicitudes de extracción.

Configuración y entornos

En lugar de la settings.py predeterminada.py, utilizo un directorio de configuración con archivos separados para la configuración del entorno local y de producción. ¡Esto ayuda a evitar los percances de configuración errónea!

Puede pasar el archivo de configuración como argumento, por ejemplo, al ejecutar el servidor de desarrollo:

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

El comando Makefile make dev usa esto. Hablando de ...

Un makefile súper útil

Imagine tener una CLI súper útil y específica del proyecto que recuerda perfectamente todas sus acciones de desarrollo típicas para usted. Por ejemplo, en lugar de escribir ...

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

Puedes hacer:

make test

¿No es eso mejor? ¡Creo que sí! Echa un vistazo a la base autodocumental para ver cómo facilita otras acciones cotidianas. (¿Por qué es autodocumental? Simplemente escriba make help y vea).

Que contribuye

¿Tienes algo para agregar? ¡No dude en abrir una solicitud de extracción!