Skip to content

Commit caa35d7

Browse files
waldekmastykarzVesaJuvonen
authored andcommitted
Updated the development environment setup guide (SharePoint#958)
1 parent ee45f8c commit caa35d7

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

docs/spfx/set-up-your-development-environment.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ You can use Visual Studio, or your own custom development environment to build S
1111

1212
>**Note:** Before following the steps in this article, be sure to [Set up your Office 365 Tenant](./set-up-your-developer-tenant.md).
1313
14-
You can also follow these steps by watching the video on the [SharePoint PnP YouTube Channel](https://www.youtube.com/watch?v=_fxYexlUhe0&t=5s&list=PLR9nK3mnD-OXvSWvS2zglCzz4iplhVrKq&index=1).
14+
You can also follow these steps by watching the video on the [SharePoint PnP YouTube Channel](https://www.youtube.com/watch?v=_fxYexlUhe0&t=5s&list=PLR9nK3mnD-OXvSWvS2zglCzz4iplhVrKq&index=1).
1515

1616
<a href="https://www.youtube.com/watch?v=_fxYexlUhe0&t=5s&list=PLR9nK3mnD-OXvSWvS2zglCzz4iplhVrKq">
1717
<img src="../images/spfx-youtube-tutorial0.png" alt="Screenshot of the YouTube video player for this tutorial" />
1818
</a>
1919

20-
2120
## Install developer tools
2221

2322
### NodeJS
23+
2424
Install [NodeJS](https://nodejs.org/en/) Long Term Support (LTS) version.
2525

2626
* If you have NodeJS already installed please check you have the latest version using `node -v`. It should return the current [LTS version](https://nodejs.org/en/download/).
@@ -29,27 +29,28 @@ Install [NodeJS](https://nodejs.org/en/) Long Term Support (LTS) version.
2929
> Notice that SPFx build pipeline does **NOT** currently support npm v5.x, so you'll need to use either v3 or v4. At the time of the writing, NodeJS LTS version (v6.11.0) installs npm v3.10.10. We'll update this section when there are changes in the supportability statement. You can downgrade to older npm version with following command `npm install -g npm@3`.
3030
3131
### Code Editors
32+
3233
Install a code editor. You can use any code editor or IDE that supports client-side development to build your web part, such as:
3334

3435
* [Visual Studio Code](https://code.visualstudio.com/)
3536
* [Atom](https://atom.io)
36-
* [Webstorm](https://www.jetbrains.com/webstorm)
37+
* [Webstorm](https://www.jetbrains.com/webstorm)
3738

38-
The steps and examples in this documentation use [Visual Studio Code](https://code.visualstudio.com/), but you can use any editor of your choice.
39+
The steps and examples in this documentation use [Visual Studio Code](https://code.visualstudio.com/), but you can use any editor of your choice.
3940

4041
### If you are using Ubuntu
4142

4243
You need to install compiler tools using the following command:
43-
44-
```
44+
45+
```sh
4546
sudo apt-get install build-essential
4647
```
4748

4849
### If you are using fedora
4950

5051
You need to install compiler tools using the following command:
51-
52-
```
52+
53+
```sh
5354
sudo yum install make automake gcc gcc-c++ kernel-devel
5455
```
5556

@@ -58,22 +59,26 @@ sudo yum install make automake gcc gcc-c++ kernel-devel
5859
[Yeoman](http://yeoman.io/) helps you kick-start new projects, and prescribes best practices and tools to help you stay productive. SharePoint client-side development tools include a Yeoman generator for creating new web parts. The generator provides common build tools, common boilerplate code, and a common playground web site to host web parts for testing.
5960

6061
Enter the following command to install Yeoman and gulp:
61-
62-
```
62+
63+
```sh
6364
npm install -g yo gulp
6465
```
6566

6667
## Install Yeoman SharePoint generator
6768

6869
The Yeoman SharePoint web part generator helps you quickly create a SharePoint client-side solution project with the right toolchain and project structure.
6970

70-
Enter the following command to install the Yeoman SharePoint generator:
71-
72-
```
73-
npm install -g @microsoft/generator-sharepoint
71+
To install the SharePoint Framework Yeoman generator globally, enter the following command:
72+
73+
```sh
74+
npm install -g @microsoft/generator-sharepoint
7475
```
75-
>**Note:** Yeoman generator for SharePoint is targeted to get deployed globally with the initial General Availability (GA) version. There are some known issues if it's installed locally to the project, which are planned to be addressed post GA.
7676

77+
If you need to switch between the different projects created using different versions of the SharePoint Framework Yeoman generator, you can install the generator locally as a development dependency in the project folder by executing the following command:
78+
79+
```sh
80+
npm install @microsoft/generator-sharepoint --save-dev
81+
```
7782

7883
## Optional tools
7984

0 commit comments

Comments
 (0)