SharePoint Framework(SPFx)開発環境を構築する

  • このエントリーをはてなブックマークに追加

SharePoint Framework(以下SPFx)で独自アプリを作成するには、まず環境構築が必要になります。
環境構築と言うと難しく感じますが、必要なアプリをいくつかインストールしているだけなので、やってみると簡単です。


SPFxの作成に必要なツール

SPFxを利用するために必要なツール一覧です。たくさんありますが、一つずつ試していきましょう。

  1. Node.js(v16系)
  2. Gulp
  3. Yeoman
  4. Yeoman SharePointジェネレーター(3の追加パックのようなもの)

ツールをインストールするために

前項で説明したツールをインストールするために、Visual Studio Code(以下VSCode)などのエディターを使います。Power Shellでも構いません。どちらもないようであればインストールしてください。

⇒VSCodeのダウンロードはこちら

VSCodeのターミナルを起動する

ツールをインストールするために、VSCodeを起動して、ターミナルを開きます。
[ ターミナル ]>[ 新しいターミナル ]
ターミナルが開けたら、ひとまずこのままにしておいてください。後程使用します。


Node.js(v16)をインストールする

まずは、Node.jsをインストールします。Node.jsはサイトからインストーラーをダウンロードできます。
⇒ https://nodejs.org/en/download/prebuilt-installer


Node.jsのWEBサイトです。SPFxに対応しているのはv16ですので、16系の一番新しいものを落としてきます。(2024年9月時点ではv16.20.2でした)



起動したインストーラーの画面です。英語ですが、基本は画面の通りにインストールすれば完了です。


Gulpをインストールする

次に、Gulpをインストールします。


コマンドを入力して実行

先程起動したVSCodeのターミナルに、以下のコマンドを入力します。


開いたターミナルウィンドウに、コマンドという呪文のようなテキストを入力して実行します。テキストをコピーして、VSCodeのターミナル上で右クリックを押すと勝手にペーストされます。この状態でEnterを押せば実行されます。

少し待つと、インストール完了です。


Yeomanをインストールする

Yeomanをインストールします。
Gulpと同じように、VSCodeのターミナルにコマンドを入力して実行します。

コマンドを入力して実行

Yeomanをインストールするコマンドはこちらです。


コマンドをターミナルにペーストして、Enterで実行します。

しばらくすると、インストールが完了します。


YeomanのSharePointジェネレーターをインストールする

最後に、SharePointジェネレーターをインストールします。


コマンドをターミナルにペーストして、Enterで実行します。

しばらくすると、インストールが完了します。


以上で、必要なツールのインストールが完了しました。


エラーが出てしまった時は

コマンドを実行した時に、赤い文字のエラーが出て、インストールが失敗してしまう時があります。そんな時はエラーメッセージをコピーしてChatGPTに聞いてみるのがおすすめです。エラーの多くはPCの環境に依存するため、エラーの内容を解消することが重要です。エラーメッセージをコピーするには、マウスドラッグで選択して、Ctrl+Cです。


以上で、環境構築が完了しました。

執筆者:森島[ WEBデザイナー ]

8bit デザイナーです。 デザイン・マークアップ・映像制作など幅広く担当しています。

関連記事

プログラミング

SharePoint リストに書式の変更からJSONで記述してCSSを適用する方法

SharePointのモダンUIで、リストの書式設定をJSON形式で入力することにより、カスタムCSSを適用してみましょう。 今回は、このようなリンクリストを作成します。 WEBパーツで似たような形を作れますが、細かいCSSが調整できません。リストのWEBパーツとして複数のページで使用すると、一度の修正で全てのページに修正が適用されます。サイト内で共通で使いたいパーツをこのように使用すると便利です。 目次1 前提条件1.1 使用できるHTMLタグやCSSが限られている2 リス […]

プログラミング

SharePointで作成したサイトを別環境にコピーする方法(サイトテンプレートの使い方)

SharePointのモダンUIで作成したサイトは、サイトテンプレートを生成すると簡単に複製できます。 テスト環境で作成したサイトを本番環境に移行する場合などに使えるかもしれません。 目次1 前提条件1.1 権限の確認2 手順3 1.カスタムスクリプトを許可する4 2.サイトをテンプレートとして保存5 3.新規サイトを作成6 4.テンプレートを適用 前提条件 SharePoint Online モダンUI チームサイト サイトテンプレートがサポートされているのはチームサイトの […]

プログラミング

SharePoint Framework(SPFx)で作ったカスタムアプリをサイトに追加・公開する方法

SharePointのモダンUI向けに作成したSharePoint Framework(以降SPFx)の独自アプリを、SharePoint Onlineに展開するには、パッケージ化してサイトに追加する必要があります。 今回はサイトに適用するまでの方法と手順をまとめました。 目次1 前提条件1.1 権限の確認2 1.パッケージ化3 2.App Catalogからアプリをアップロード、動作を確認3.1 App Catalogにアクセスし、.sppkgファイルをアップロード3.2 […]

株式会社8bit (エイトビット)

東京都目黒区でWebサイト制作、Webシステム開発などを行っております。
コーポレートサイトやWebサービスの企画・提案を得意としており、自社での経験を元にアイデアをカタチにするお手伝いをさせていただいております。

Web制作に関するご相談はお気軽にどうぞ

弊社に制作をご依頼いただく際の費用感をご確認いただける、
見積りシミュレーションをご用意いたしました。