GROWI Docs

(旧版) 開発環境の構築

WARNING

このページで紹介している開発スタートアップは旧版です。
ホストOSで node をセットアップし、実行します。

より快適な開発を行うには、Dev in Container を採用した 開発スタートアップ v2 を利用してください。

TIP

以下は WESEEK, Inc. での統一開発環境の紹介です。 そのため、開発にあたって必須ではない設定やツールの指定が含まれています。

マージツールの準備

  1. P4Merge (Helix Visual Client (P4V)) インストール
  2. P4Merge 設定
    • Diff タブで適当にファイルを2つ選択して OK
    • Edit -> Preferences...
      • 「Character encoding」で「Unicode (UTF-8, no BOM)」または BOM 表記のない「Unicode(UTF-8)」を選択
      • 「Line ending type」で「UNIX (LF)」を選択

Gitクライアントの準備

  1. SourceTreeインストール
    • https://ja.atlassian.com/software/sourcetree からDLしてインストールする
    • 「Git が見つかりませんでした」というダイアログが表示された場合は、「システム全体でなく、SourceTree 単独で使うためだけの内蔵用の Git をダウンロードする。」を選択
  2. SourceTree設定
    1. SourceTree からターミナルを開く
    2. autoCRLF を無効化する
      • 以下をコピペして実行 git config --global core.autoCRLF false
    3. 自身のアカウント情報を設定
      • 「ツール > オプション > 全般」...
      • 「デフォルトのユーザ情報」を適宜設定
    4. P4Merge を設定
      • 「ツール > オプション > Diff」...
      • 「外部Diffツール」「マージツール」で「P4Merge」を選択
    5. デフォルトの文字コード設定
      • 「ツール > オプション > 全般」...
      • 「デフォルトの文字コード」で「utf-8」を選択

Node.js 実行環境のインストール

Node.js, npm, Yarn 共に、CI 環境で利用する node:12 のバージョンに合わせる

    バージョンの確認

    $ node -v
v12.14.0
$ npm -v
6.13.4
$ yarn -v
1.19.1

    エディタの準備

    1. Visual Studio Code インストール
    2. 拡張機能をインストール
      • インストール方法
        • Ctrl + Shift + P -> 「Extensions: Show Recommended Extensions」を選択して全てインストール

    開発環境の依存インフラの準備

    WARNING

    Docker 環境をネイティブで準備できない場合のみ、以下の手順が必要

    1. VirtualBox インストール
    2. Vagrant インストール

      • https://www.vagrantup.com/downloads.html からDLしてインストールする

      • Vagrantfile を作成

        Vagrant.configure(2) do |config|
  config.vm.box = "chaifeng/ubuntu-18.04-docker-19.03"
  ### provision
  ### change mirror to Japanese location
  config.vm.provision "shell", inline: <<-SHELL
    sed -i.bak -e "s%http://archive.ubuntu.com/ubuntu/%http://ftp.iij.ad.jp/pub/linux/ubuntu/archive/%g" /etc/apt/sources.list
  #SHELL
  ### install apt packages
  config.vm.provision "shell", preserve_order: true, inline: <<-SHELL
    apt-get update && apt-get install -q -y tmux git nano less
  SHELL
  ### install docker-compose
  config.vm.provision "shell", preserve_order: true, inline: <<-SHELL
    curl -sL "https://github.com/docker/compose/releases/download/1.25.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
    chmod +x /usr/local/bin/docker-compose
  SHELL
  ### clone git repos
  config.vm.provision "shell", privileged: false, inline: <<-SHELL
    git -C growi-docker-compose pull || git clone https://github.com/weseek/growi-docker-compose
  SHELL
  ## port forwarding
  # Proxy
  config.vm.network "forwarded_port", guest: 80, host: 80, host_ip: "127.0.0.1"
  config.vm.network "forwarded_port", guest: 443, host: 443, host_ip: "127.0.0.1"
  # App
  #config.vm.network "forwarded_port", guest: 3000, host: 3000, host_ip: "127.0.0.1"
  # App2
  config.vm.network "forwarded_port", guest: 3010, host: 3010, host_ip: "127.0.0.1"
  # MongoDB
  config.vm.network "forwarded_port", guest: 27017, host: 27017, host_ip: "127.0.0.1"
  # Redis
  config.vm.network "forwarded_port", guest: 6379, host: 6379, host_ip: "127.0.0.1"
  # ElasticSearch
  config.vm.network "forwarded_port", guest: 9200, host: 9200, host_ip: "127.0.0.1"
  # elasticsearch-head
  config.vm.network "forwarded_port", guest: 9100, host: 9100, host_ip: "127.0.0.1"
  # MariaDB
  config.vm.network "forwarded_port", guest: 3306, host: 3306, host_ip: "127.0.0.1"
  # phpMyAdmin
  config.vm.network "forwarded_port", guest: 8080, host: 8080, host_ip: "127.0.0.1"
  # Provider Options
  config.vm.provider "virtualbox" do |vb|
    vb.customize ["modifyvm", :id, "--memory", "4096"]
  end
end

    ← (旧版) 起動 →