django starter

Django Starter

Gehen Sie von einer neuen Umgebung zu einem Django -Projekt, bevor Ihr Kaffee abkühlt!

Ich habe alle meine Best Practices in Django in dieses Starter -Repository gesteckt, damit Sie sofort beginnen können.

Dies wird Ihnen helfen:

• Führen Sie Tests und Django -Sicherheitsprüfung über GitHub -Aktionen aus
• Arbeiten Sie schneller mit einem selbstdokumentierenden Makefile, das auf Django zugeschnitten ist
• Format Dateien, bevor Sie sich mit dem Vorverfahren verpflichten
• Holen Sie sich Python 3.9, Pip, Pipenv und Django in einer neuen Umgebung
• Arbeiten Sie mit einem. Gitignore, der auf Python und Django Development zugeschnitten ist
• Richten Sie eine Docker Postgres -Datenbank ein und verlinken Sie

Verwendung

1. Klonen Sie dieses Repository klonen

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

2. Stellen Sie Ihre Umgebungsvariablen ein

./env-setup.sh

(Es ist immer eine gute Idee, Skripte zu lesen, bevor Sie sie ausführen! Wenn Sie es nicht tun, danke für die Bitcoin.)

3. Installieren Sie Abhängigkeiten

Machen Sie make install , um Abhängigkeiten in einer virtuellen Umgebung zu installieren.

Wenn Sie helfen möchten, nur Django über Pipenv zu installieren, rennen Sie ./django-setup.sh .

4. Profit !!!

Sie können jetzt make dev um eine ziemlich willkommene Seite unter http://localhost:8000/ zu sehen und zu testen, dass alles richtig funktioniert.

Bauen Sie an! Wenn Sie neu in Django sind, lesen Sie ihre großartigen Tutorials.

Run make help um zu sehen, was ich sonst noch für Sie eingerichtet habe.

Was und warum

Im Laufe der Jahre, in denen ich mich mit Django entwickelt habe, habe ich eine Reihe von Entwicklerwerkzeugen, Praktiken aufgebaut, die Programmierer effizienter machen, und viele kleine Tipps und Ideen, die das Gebäude mit Django erleichtern.

Ich habe über viele davon geschrieben und wollte es Ihnen auch leichter machen, sie auch zu benutzen!

Automatisierung

Sie können die Automatisierung nutzen, um Entwickler daran zu hindern, dass Sie sich daran erinnern müssen, Linien, Tests und andere Routineaktionen auszuführen. Die Verwendung von Vorverbänden und Flüssen wie GitHub-Aktionen kann dazu beitragen, dass Ihre Codebasis konsistent, getestet und leichter zu entwickeln ist.

• Diese Konfiguration vor der Kommunikation hilft bei der Formatierung von Code und Dokumentation und sogar nach versehentlich begangenen Anmeldeinformationen!
• Ich habe GitHub -Aktionen für die Ausführung Ihrer Testsuite und Ihre Django -Sicherheitsprüfung für Pull -Anfragen beigefügt.

Einstellungen und Umgebungen

Anstelle der settings.py verwende ich ein Einstellungsverzeichnis mit separaten Dateien für lokale und Produktionsumgebungseinstellungen. Dies hilft, Missverständlichkeiten zu vermeiden!

Sie können die Einstellungsdatei als Argument übergeben, beispielsweise beim Ausführen des Entwicklungsservers:

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

Der Befehl makefile make dev dies verwenden. Apropos ...

Ein super hilfreiches Makefile

Stellen Sie sich vor, eine super hilfsbereite, projektspezifische CLI, die sich an alle Ihre typischen Entwicklungsaktionen für Sie erinnert. Zum Beispiel anstatt zu tippen ...

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

Sie können einfach:

make test

Ist das nicht besser? Ich glaube schon! Schauen Sie sich das selbstdokumentierende MakeFile an, um zu sehen, wie es andere alltägliche Handlungen erleichtert. (Warum selbstdokumentiert es? Geben Sie einfach make help und sehen Sie.)

Beitragen

Haben Sie etwas hinzuzufügen? Fühlen Sie sich frei, eine Pull -Anfrage zu öffnen!