django starter

Djangoスターター

コーヒーが冷える前に、新しい環境からDjangoプロジェクトを開始します！

私はすべてのDjangoのベストプラクティスをこのスターターリポジトリに入れて、すぐに構築を開始できるようにします。

これはあなたを助けます：

• GitHubアクションを介してテストとDjangoセキュリティチェックを実行します
• Djangoに合わせた自己文書化されたMakefileでより速く作業します
• 事前コミットでコミットする前にファイルをフォーマットします
• Python 3.9、Pip、Pipenv、およびDjangoを新しい環境にインストールしてください
• PythonとDjango Developmentに合わせた.Gitignoreを使用して作業
• Docker Postgresデータベースをセットアップしてリンクします

使用法

1。このリポジトリをクローンします

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

2.環境変数を設定します

./env-setup.sh

（実行する前にスクリプトを読むことをお勧めします！

3.依存関係をインストールします

仮想環境に依存関係をインストールするためにmake installください。

Pipenv経由でDjangoのみのインストールを支援したい場合は、run ./django-setup.shを実行してください。

4。利益!!!

http://localhost:8000/でかなりウェルカムページを表示して、すべてが適切に機能していることをテストするためにmake devできるようになりました。

構築を始めましょう！ Djangoを初めて使用する場合は、素晴らしいチュートリアルをご覧ください。

私があなたのためにセットアップした他のものを見るためにmake helpを実行してください。

何となぜ

長年にわたり、Djangoで開発してきましたが、開発者ツールのスイート、プログラマーをより効率的にするのに役立つプラクティス、Djangoの構築を容易にする多くの小さなヒントやアイデアを構築しました。

私はこれらの多くについて書いており、あなたもそれらを使いやすくしたいと思っていました！

オートメーション

自動化を利用して、開発者が糸くず、テスト、その他の日常的なアクションを実行することを忘れないことを免除することができます。 GitHubアクションのような事前コミットとフローの使用は、コードベースの一貫性、テスト、開発が容易になるのに役立ちます。

• この事前コミット構成は、コードとドキュメントのフォーマットに役立ち、誤ってコミットされた資格情報を確認することもできます。
• PullリクエストでテストスイートとDjangoセキュリティチェックを実行するためのGitHubアクションを含めました。

設定と環境

デフォルト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

それは良くありませんか？そう思います！自己文書化されたメイクファイルをチェックして、それが他の日常のアクションをどのように容易にするかを確認してください。 （なぜそれは自己文書化されているのですか？ただタイプのmake help見るのです。）

貢献

追加するものがありますか？プルリクエストを自由に開いてください！