Skip to content

Latest commit

 

History

History
152 lines (114 loc) · 4.78 KB

readme.md

File metadata and controls

152 lines (114 loc) · 4.78 KB

Docker + WSLg GUI-Template

English | 日本語

概要

wsl-ubuntu

Docker + WSLg + devcontainer.json + Pythonのテンプレートです。

サンプルはpythonですが、他のイメージでも可能です。

目次

前提条件

必須

  • Windows 11 (WSLgのため)

  • WSLg

    (WindowsでDockerのGUIを表示するために必要)

  • git

  • Docker Desktop for Windows (仮想コンテナーによる任意の環境構築のため)

任意

クイックスタート

警告: 必ずWSLのディレクトリ内で実行してください。 でないと正しくwslgディレクトリが正しくマウントされず、GUIが表示できません。


VS code以外のエディタをお使いの場合

Step 1: 以下のコマンドを実行します。

git clone https://github.com/SARDONYX-sard/docker-wslg-gui-template.git
cd docker-wslg-gui-template

Step2: 以下のコマンドを実行後、作成されたコンテナに入ってください。

make compose

VS codeをお使いの場合

Step 1: 以下のコマンドを実行します。

git clone https://github.com/SARDONYX-sard/docker-wslg-gui-template.git
cd docker-wslg-gui-template
code .

Step 2: 左下のWSL: <Linux name>というアイコンをクリックします。

wsl-ubuntu

Step 3: 中央に現れたパレットからReopen in Containerというを項目を選択します。

wsl-ubuntu

Make の使い方

コマンド 説明
make compose-conf .env.wslを設定し、 docker-compose.yml の設定を表示
make compose-up docker-compose.yml によってコンテナーを作成
make start pythonファイル(デフォルト: src/main.py) を実行
make install-dev 依存関係のインストール(開発用)
make install 依存関係のインストール (本番用)
make test pytestでテスト実行
make lint pysenを使ったLint
make lint-fix pysenを使ったコードの自動整形と修正
make ci 依存関係の再インストール
make clean __pycache__ ファイル、.venvディレクトリを削除

Windowsをお使いの場合、こちらからmakeコマンドをインストールできます。(setupボタンをクリックします)

ディレクトリ構造

docker-wslg-gui-template
├── .devcontainer
|  └── devcontainer.json
├── .editorconfig
├── .github
|  ├── dependabot.yml
|  └── workflows
|     └── ci.yml
├── docker
|  ├── .env.wslg
|  ├── Dockerfile
|  └── docker-compose.yml
├── docs
|  ├── i18n
|  |  └── jp
|  └── images
|     └── gui-sample.png
├── scripts
|  └── set-wslg.sh
├── src
|  ├── main.py
|  └── utils
|     ├── __init__.py
|     └── operator.py
├── tests
|  ├── __init__.py
|  └── test_operator.py
├── .gitignore
├── LICENSE
├── Makefile
├── poetry.lock
├── pyproject.toml
└── README.md

ライセンス

Unlicense