django starter

Starter django

Pergi dari lingkungan baru ke memulai proyek Django sebelum kopi Anda dingin!

Saya memasukkan semua praktik terbaik Django saya ke dalam repositori starter ini sehingga Anda dapat mulai membangun segera.

Ini akan membantu Anda:

• Jalankan tes dan pemeriksaan keamanan django melalui tindakan github
• Bekerja lebih cepat dengan makefile yang didokumentasikan sendiri yang disesuaikan dengan Django
• Format file sebelum berkomitmen dengan pra-komit
• Dapatkan Python 3.9, Pip, Pipenv, dan Django dipasang di lingkungan baru
• Bekerja dengan .Gitignore yang disesuaikan dengan Python dan Django Development
• Mengatur dan menautkan database Docker Postgres

Penggunaan

1. Kloning repositori ini

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

2. Atur variabel lingkungan Anda

./env-setup.sh

(Selalu merupakan ide yang bagus untuk membaca skrip sebelum menjalankannya! Jika tidak, well, terima kasih untuk bitcoin.)

3. Pasang dependensi

Lakukan make install untuk menginstal dependensi di lingkungan virtual.

Jika Anda ingin membantu menginstal hanya Django melalui Pipenv, jalankan ./django-setup.sh .

4. Laba !!!

Anda sekarang dapat make dev untuk melihat halaman yang cukup disambut di http://localhost:8000/ dan menguji bahwa semuanya berfungsi dengan baik.

Mulailah membangun! Jika Anda baru mengenal Django, lihat tutorial hebat mereka.

Jalankan make help untuk melihat apa lagi yang saya atur untuk Anda.

Apa dan mengapa

Selama bertahun -tahun saya telah berkembang dengan Django, saya telah membangun serangkaian alat pengembang, praktik yang membantu membuat programmer lebih efisien, dan banyak tips dan ide kecil yang membuat pembangunan dengan Django lebih mudah.

Saya telah menulis tentang banyak dari ini, dan ingin memudahkan Anda menggunakannya juga!

Otomatisasi

Anda dapat memanfaatkan otomatisasi untuk meringankan pengembang karena harus ingat menjalankan serat, tes, dan tindakan rutin lainnya. Penggunaan pra-komit dan aliran seperti tindakan github dapat membantu menjaga basis kode Anda konsisten, diuji, dan lebih mudah untuk dikembangkan.

• Konfigurasi pra-komit ini membantu memformat kode dan dokumentasi, dan bahkan memeriksa kredensial yang tidak sengaja berkomitmen!
• Saya telah memasukkan tindakan github untuk menjalankan test suite Anda dan pemeriksaan keamanan django pada permintaan tarik.

Pengaturan dan Lingkungan

Alih -alih settings.py default.py, saya menggunakan direktori pengaturan dengan file terpisah untuk pengaturan lingkungan lokal dan produksi. Ini membantu menghindari kecelakaan konfigurasi yang salah konfigurasi!

Anda dapat melewati file pengaturan sebagai argumen, misalnya saat menjalankan server pengembangan:

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

Perintah Makefile make dev menggunakan ini. Berbicara tentang ...

Makefile yang sangat membantu

Bayangkan memiliki CLI yang sangat membantu dan khusus proyek yang dengan rapi mengingat semua tindakan pengembangan khas Anda untuk Anda. Misalnya, alih -alih mengetik ...

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

Anda bisa melakukannya:

make test

Bukankah itu lebih baik? Saya kira demikian! Lihatlah Makefile yang mendokumentasikan diri untuk melihat bagaimana hal itu membuat tindakan sehari-hari lainnya lebih mudah. (Kenapa mendokumentasikan diri? Ketik saja, make help dan lihat.)

Berkontribusi

Ada sesuatu untuk ditambahkan? Jangan ragu untuk membuka permintaan tarik!