SPFxハンズオン開発シリーズ 第1回：開発環境の構築

<h1>はじめに</h1>

<p>
1.はじめに<br>
モダンなSharePointサイトをカスタマイズしたい、独自のWebパーツを作成したい。<br>
そんなニーズに応えるのがSharePoint Framework（以降、SPFx）です。<br>
SPFxを活用すれば、企業のポータルサイトや業務アプリを柔軟に拡張し、より使いやすいSharePointサイトを構築できます。

しかし、SPFxの開発を始めるには、適切な環境を整えることが不可欠です。
本記事では、SPFxの基本的な概念から、必要な開発環境をゼロから構築する方法までをハンズオン形式で説明します。

Webパーツの開発方法や、デプロイの方は別記事で紹介しておりますので、下記の目次よりご参照ください。

2.連載の目次
**・SPFxハンズオン開発シリーズ 第1回：開発環境の構築（※本記事）**
・SPFxハンズオン開発シリーズ 第2回：Webパーツの開発
・SPFxハンズオン開発シリーズ 第3回：Webパーツのデプロイ
</p>

<h1>目次</h1>
<a href="https://qiita.com/kuwada0222/private/faf158e8b1378c12b778#spfxについて--spfxとは">1. SPFxについて</a><br>
<a href="https://qiita.com/kuwada0222/private/faf158e8b1378c12b778#spfxについて--システム要件">2.SPFx開発環境の構築</a><br>
<a href="https://qiita.com/kuwada0222/private/faf158e8b1378c12b778#まとめ">3.まとめ</a><br>
<a href="https://qiita.com/kuwada0222/private/faf158e8b1378c12b778#最後に">4.最後に</a><br>


<h1>SPFxについて – SPFxとは</h1>
<p>
〇概要
SharePoint Framework（SPFx）は、SharePointのモダンUIのカスタマイズやWebパーツの開発を行うためのフレームワークです。

〇 開発できる機能
SPFxを活用すると、SharePointのWebパーツ・拡張機能の開発やTeamsのUIのカスタマイズなどが可能です。
使用例は下記の通りです。
・Webパーツの開発
　- SharePointページに追加できるカスタムWebパーツ
・拡張機能の開発（SharePointのUIカスタマイズ）
　- ヘッダー・フッターの追加
　- リストの列の表示方法のカスタマイズ
　- リストのツールバーに独自のボタンを追加
　- リスト右クリックメニューに独自の処理を追加
・Teams機能の開発
　- Teamsタブアプリの開発
　- Teams個人アプリの開発
 
〇開発の流れ
SPFxを用いたアプリ開発は、大きく5つのステップに分かれます。
SPFxハンズオン開発シリーズでは
第1回にてSTEP 01
第2回にてSTEP 02.03
第3回にてSTEP 04.05
の説明を行います。
![スクリーンショット 2025-03-25 154246.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/ba87c6da-ecef-4790-a56d-e5478c9ac69e.png)
</p>

<h1>SPFxについて – システム要件</h1>
<p>
1.実行環境のシステム要件
SPFxは、SharePointのバージョンによって利用できる機能が異なります。<br>
Microsoft公式ドキュメントも併せてご確認ください。<br>
URL：<a href="https://learn.microsoft.com/ja-jp/sharepoint/dev/spfx/compatibility#sharepoint-framework-version-compatibility">SharePoint Framework の開発ツールとライブラリの互換性 | Microsoft Learn</a>

|SharePointバージョン |サポートされている<br>SPFxバージョン |サポートされている機能 |
|---|---|---|
|SharePoint Online |すべてのバージョン |すべての機能 |
|SharePoint Server<br> Subscription Edition  |v1.4.1 以前 |クラシック & モダンのWebパーツ<br>モダンページの拡張機能  |
|SharePoint Server 2019  |v1.4.1 以前 |クラシック & モダンのWebパーツ<br>モダンページの拡張機能  |
|SharePoint 2016 <br> Feature Pack 2  |v1.1 |クラシックでホストされる<br>Webパーツ  |

2. 開発環境のシステム要件
SPFx開発環境を開発するには、以下のツールが必要となります。

|ツール |意味 |
|---|---|
|VS Code |Visual Studio Codeの略称<br>SPFxのアプリ開発に用いるコードエディター |
|Node.js |JavaScript実行環境<br>サーバー上でJavaScriptを動かすために必要<br>SPFxでは16系（LTS版）を推奨 |
|Gulp |SPFxアプリの開発、テスト、ビルド、パッケージ化を行うツール |
|Yeoman |SPFxのプロジェクト生成ツール |
|Yeoman SharePoint<br> Generator |SPFxプロジェクトのテンプレートを作成するためのツール<br>必要なファイルや設定を自動で実行 |
</p>

<h1>SPFx開発環境の構築</h1>
<p>
SharePoint Framework（SPFx）を使って開発を行うには、適切な環境を準備することが重要です。本記事では、SPFx開発環境の構築手順をハンズオン形式で説明します。<br>
それぞれのツールの役割について理解しながら、開発環境の構築を進めてください。

〇開発環境の構築手順
![スクリーンショット 2025-03-25 160900.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/5808bf16-ff1a-4b89-9a5c-b61b9f67d988.png)

STEP 01
SPFxの開発環境の構築に使用するエディタ、VS Code (Visual Studio Code)をインストールします。
サイトのインストーラから最新のVS Codeをインストールします。

![画像1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/dd9c07ea-67a1-4e98-af3b-2d1084e7a094.png)
URL:<a href="https://code.visualstudio.com/">Visual Studio Code - Code Editing. Redefined</a>

STEP 02
通常、ブラウザ内で動作するJavaScriptをサーバー上でも動作させるために、JavaScriptの実行環境をインストールします。
Node.jsをインストールします。
本記事作成時点では、SPFxに対応しているバージョンは16となります。
![画像2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/b675130a-d363-456a-a8ba-e1c4c92e0d29.png)
URL:<a href="https://nodejs.org/en/download">Node.js — Download Node.js®</a>

STEP 03-1
インストールしたVS Codeを起動します。
![画像3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/b2f1fe61-b5c5-4c86-a5c9-fb5875c4a8af.png)
![スクリーンショット 2025-04-03 141333.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/66ffc0d0-6393-447d-8249-ce17313ad099.png)

STEP 03-2
ターミナル>新しいターミナルの順にクリックします。
![4.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/633e0246-2575-4939-919d-8abafc3b7848.png)
![画像3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/35572f38-8e30-438d-a382-2642789cdbb7.png)

STEP 03-3
開発中のSPFxアプリのテストや、本番環境向けのビルドやパッケージ化に必要なツールをインストールします。
Gulpをインストールします。
起動したVS Codeのターミナルに以下のコマンドを入力し、Enterを押しコマンドを実行します。
```powershell
npm install gulp-cli --global
```
![画像4.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/af88d1a4-b41e-401b-b712-8f371960b914.png)

STEP 04
SPFxの開発を始めるためのプロジェクト生成ツールをインストールします。
Yeomanをインストールします。
VS Codeのターミナルに以下のコマンドを入力し、Enterを押しコマンドを実行します。
```powershell
npm install yo --global
```
![画像5.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/cff27a15-8e0d-450e-b2dd-93201fc4befc.png)
![画像6.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/ce4c159f-840e-4385-84bc-477b9f14fa27.png)

STEP 05
SPFxプロジェクト生成時に必要なファイルや設定を自動で実行するためのツールをインストールします。
SharePoint Generatorをインストールします。
VS Codeのターミナルに以下のコマンドを入力し、Enterを押しコマンドを実行します。
```powershell
npm install @microsoft/generator-sharepoint --global
```
![7.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/bd126c9c-734c-4ed1-91a2-f71189caa297.png)
![画像7.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3988086/2bc6ce6c-8d37-4ff7-9364-f0f57622aac5.png)

以上でSPFxの開発環境の構築は完了となります。
</p>

<h1>まとめ</h1>
<p>
SPFxはSharePointのカスタマイズや拡張を行う上で、非常に強力なツールです。標準機能では実現できない柔軟なUIや機能を実装できます。<br>
本記事で紹介した開発環境の構築手順を実践することで、今後SPFxでWebパーツの開発やCSS、JSを活用したカスタマイズを行うための基盤を整えることができます。<br>
次回の記事では、開発環境を活用してSPFxプロジェクトの作成からWeb パーツの作成、動作確認までの流れをハンズオンで紹介します。<br>
SPFx 開発についてより詳しく知りたい方は、ぜひ今後の記事もご確認ください。
</p>

<h1>最後に</h1>
<p>
テンダでは、「こんなプロジェクトに挑戦したい」「こんなチームで働きたい」「理想のチームを創りたい」と願う仲間を求めています。
カジュアル面談も随時受付中です。ぜひ一度お話ししましょう！

・<a href="https://hrmos.co/pages/tenda/jobs">募集職種一覧</a>
・<a href="https://hrmos.co/pages/tenda/jobs/031002/apply">カジュアル面談の申込</a>
・<a href="https://note.com/tenda_recruit">テンダで働く人や社風について</a>
・<a href="https://mssp.tenda.co.jp/">テンダのMicrosoftサービス</a>
</p>