django starter

Starter django

Passez d'un nouvel environnement au démarrage d'un projet Django avant que votre café ne refroidisse!

J'ai mis toutes mes meilleures pratiques Django dans ce référentiel de démarrage afin que vous puissiez commencer à construire immédiatement.

Cela vous aidera:

• Exécutez des tests et une vérification de la sécurité Django via les actions GitHub
• Travaillez plus vite avec un fichier d'auto-documentation adapté à Django
• Format des fichiers avant de s'engager avec pré-engagement
• Installez Python 3.9, PIP, Pitenv et Django dans un nouvel environnement
• Travaillez avec un .gitignore adapté au développement de Python et Django
• Configurer et lier une base de données Docker Postgres

Usage

1. Clone ce référentiel

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

2. Définissez vos variables d'environnement

./env-setup.sh

(C'est toujours une bonne idée de lire les scripts avant de les exécuter! Si vous ne le faites pas, eh bien, merci pour le Bitcoin.)

3. Installez les dépendances

Faites make install pour installer des dépendances dans un environnement virtuel.

Si vous souhaitez aider à installer simplement Django via PiPenv, exécutez ./django-setup.sh .

4. Profit !!!

Vous pouvez maintenant faire make dev pour voir une page assez bienvenue sur http://localhost:8000/ et tester que tout fonctionne correctement.

Commencez à construire! Si vous êtes nouveau à Django, consultez leurs excellents tutoriels.

Run make help pour voir ce que j'ai confié d'autre pour vous.

Quoi et pourquoi

Au fil des ans, je me suis développé avec Django, j'ai construit une suite d'outils de développeur, des pratiques qui aident à rendre les programmeurs plus efficaces et beaucoup de petits conseils et idées qui facilitent la construction avec Django.

J'en ai écrit beaucoup et je voulais vous faciliter la tâche de les utiliser!

Automation

Vous pouvez profiter de l'automatisation pour soulager les développeurs de devoir se rappeler d'exécuter la lie, les tests et d'autres actions de routine. L'utilisation de pré-engagement et de flux comme les actions GitHub peut aider à garder votre base de code cohérente, testée et plus facile à développer.

• Cette configuration de pré-engagement aide à formater le code et la documentation, et même vérifier les informations d'identification accidentellement engagées!
• J'ai inclus des actions GitHub pour exécuter votre suite de tests et la vérification de la sécurité Django sur les demandes de traction.

Paramètres et environnements

Au lieu des settings.py par défaut.py, j'utilise un répertoire de paramètres avec des fichiers séparés pour les paramètres de l'environnement local et de production. Cela aide à éviter les accidents erronés!

Vous pouvez transmettre le fichier de paramètres comme argument, par exemple lors de l'exécution du serveur de développement:

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

La commande MakeFile make dev utilise ceci. En parlant de ...

Un maquilleur super utile

Imaginez avoir une CLI super utile et spécifique au projet qui se souvient parfaitement de toutes vos actions de développement typiques pour vous. Par exemple, au lieu de taper ...

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

Vous pouvez simplement faire:

make test

N'est-ce pas mieux? Je pense que oui! Consultez le makefile auto-documenté pour voir comment il facilite les autres actions quotidiennes. (Pourquoi est-ce l'auto-documentation? Tapez simplement make help et voyez.)

Contributif

Vous avez quelque chose à ajouter? N'hésitez pas à ouvrir une demande de traction!