You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/spfx/set-up-your-developer-tenant.md
+12-8Lines changed: 12 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
-
# Set up your Office 365 developer tenant
1
+
# Set up your Office 365 tenant
2
2
3
3
>**Note:** The SharePoint Framework is currently in preview and is subject to change. SharePoint Framework client-side web parts are not currently supported for use in production environments.
4
4
5
-
To build and deploy client-side web parts using the preview release of the SharePoint Framework, you will need an Office 365 Developer Tenant. Your tenant must be a **developer tenant**, not just a site collection.
5
+
To build and deploy client-side web parts using the preview release of the SharePoint Framework, you will need an Office 365 tenant with [First Release](https://support.office.com/en-us/article/Set-up-the-Standard-or-First-Release-options-in-Office-365-3b3adfa4-1777-4ff0-b606-fb8732101f47) options enabled.
6
6
7
-
## Sign up for an Office 365 Developer Tenant
8
-
If you already have an Office 365 Developer Tenant, see [create your app catalog site](#create-app-catalog-site).
7
+
## Sign up for an Office 365 tenant
8
+
If you already have an Office 365 tenant, see [create your app catalog site](#create-app-catalog-site). Make sure you have [First Release](https://support.office.com/en-us/article/Set-up-the-Standard-or-First-Release-options-in-Office-365-3b3adfa4-1777-4ff0-b606-fb8732101f47) options enabled.
9
9
10
-
If you don't have one, sign up for the [Office Developer Program](https://profile.microsoft.com/RegSysProfileCenter/wizardnp.aspx?wizid=14b845d0-938c-45af-b061-f798fbb4d170&lcid=1033). You will receive a welcome mail with a link to sign up for an Office 365 Developer Tenant.
10
+
If you don't have one, sign up for the [Office Developer Program](https://profile.microsoft.com/RegSysProfileCenter/wizardnp.aspx?wizid=14b845d0-938c-45af-b061-f798fbb4d170&lcid=1033). You will receive a welcome mail with a link to sign up for an Office 365 Developer Tenant. First Release options are enabled already for your Office 365 Developer Tenant.
11
11
12
12
>**Note:** Make sure that you are signed out of any existing Office 365 tenants before you sign up.
13
13
@@ -68,7 +68,7 @@ In order to use the features of the SharePoint Framework, you will need to set u
68
68
* Choose **OK** to create the column.
69
69
70
70
## Put the SharePoint workbench in the document library
71
-
You need the SharePoint workbench on your developer site to test your web parts on SharePoint.
71
+
You need the SharePoint Workbench on your developer site to test your web parts on SharePoint. This procedure uses the default document library in your site collection. This will be called **Documents** in the left navigation.
72
72
73
73
* Download the [workbench.aspx](https://github.com/SharePoint/sp-dev-docs/blob/master/workbench.aspx) file to your local computer. To do this:
74
74
- Open the context menu (right-click) on the file content in the middle of the page and choose **Save Target As** or **Save Link As** (depending on your browser) to save the file as **workbench.aspx** to your local computer.
@@ -78,10 +78,14 @@ You need the SharePoint workbench on your developer site to test your web parts
78
78
79
79
## Troubleshooting
80
80
81
+
You will get an error If you are using a SharePoint site that was provisioned using a self-service site creation. We recommend using a developer site collection or a SharePoint site that was not created using a self-service site creation.
82
+
81
83
If you get the following exception when moving to the workbench.aspx page:
82
84
83
-
- "The requested operation is part of an experimental feature that is not supported in the current environment. The requested operation is part of an experimental feature that is not supported in the current environment."
84
-
- You are not using a developer tenant. You might be using a first release or normal tenant
85
+
```
86
+
"The requested operation is part of an experimental feature that is not supported in the current environment. The requested operation is part of an experimental feature that is not supported in the current environment."
87
+
```
88
+
Then, you are not using a tenant with First Release options enabled. You might be using a normal tenant
85
89
86
90
During developer preview also "Custom Script" feature will need to be enabled in site collections where you will be using the client-side web parts.
Copy file name to clipboardExpand all lines: docs/spfx/web-parts/basics/use-visual-studio.md
+12-7Lines changed: 12 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -46,12 +46,6 @@ The first step is to create the SharePoint client-side project. Use the Yeoman S
46
46
47
47
### Import your project into Visual Studio
48
48
49
-
There are two ways to open your client-side project in Visual Studio. Use the steps that work best for you.
50
-
51
-
If opening the **.njsproj** doesn't work for you, you can try importing the client-side solution project into Visual Studio.
52
-
53
-
#### Open Visual Studio and create a new project
54
-
55
49
1. In the **New Project** dialog box, select the **Templates > Other languages > TypeScript >Node.js** and then **From Existing Node.js code** project template.
56
50
Name the project the same name as your SharePoint client-side project, that is, *hello-vs-webpart*. Choose the ___location of the client-side project for the ___location, and choose **OK**.
57
51
@@ -101,7 +95,17 @@ In the project properties, change the following properties to their correspondin
101
95
102
96
### Build and debug the project
103
97
104
-
Your client-side project is now set up to work with Visual Studio. Press F5 to build and debug your project in your favorite browser.
98
+
Your client-side project is now set up to work with Visual Studio.
99
+
100
+
To preview your web part, build and run it on a local web server. The client-side toolchain uses HTTPS endpoint by default. However, since a default certificate is not configured for the local dev environment, your browser will report a certificate error. The SPFx toolchain comes with a developer certificate that you can install for building web parts.
101
+
102
+
To install the developer certificate for use with SPFx development, switch to your console, make sure you are still in the **helloworld-webpart** directory and enter the following command:
103
+
104
+
```
105
+
gulp trust-dev-cert
106
+
```
107
+
108
+
Press F5 to build and debug your project in your favorite browser.
105
109
106
110
#### Notes on debugging
107
111
@@ -120,6 +124,7 @@ All major browsers have developer tools:
120
124
The SharePoint Framework comes with a set of gulp tasks to simplify packaging your client-side solution and uploading your assets to CDN. You can use the following commands to access them:
Copy file name to clipboardExpand all lines: docs/spfx/web-parts/get-started/build-a-hello-world-web-part.md
+10-9Lines changed: 10 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -58,32 +58,33 @@ When the scaffold is complete, you should see the following message indicating a
58
58
59
59
For information about troubleshooting any errors, see [Known issues](../basics/known-issues).
60
60
61
-
### Using your favorite Code Editor/IDE
61
+
### Using your favorite Code Editor
62
62
Because the SharePoint client-side solution is HTML/TypeScript based, you can use any code editor or IDE that supports client-side development to build your web part, such as:
63
63
64
64
*[Visual Studio Code](https://code.visualstudio.com/)
65
65
*[Sublime](https://www.sublimetext.com/)
66
66
*[Atom](https://atom.io)
67
67
*[Webstorm](https://www.jetbrains.com/webstorm)
68
68
69
-
>**Note:** This article uses Visual Studio code in the steps and examples. You can use any IDE that you prefer.
70
-
71
-
### Using Visual Studio 2015
72
-
Currently, support for SharePoint client-side projects in Visual Studio is available through NodeJS Tools for Visual Studio. For more information, see [Use Visual Studio to develop web parts](../basics/use-visual-studio).
69
+
>**Note:** This article uses Visual Studio code in the steps and examples. You can use any code editor that you prefer.
73
70
74
71
## Preview the web part
75
-
To preview your web part, build and run it on a local web server.
72
+
To preview your web part, build and run it on a local web server. The client-side toolchain uses HTTPS endpoint by default. However, since a default certificate is not configured for the local dev environment, your browser will report a certificate error. The SPFx toolchain comes with a developer certificate that you can install for building web parts.
73
+
74
+
To install the developer certificate for use with SPFx development, switch to your console, make sure you are still in the **helloworld-webpart** directory and enter the following command:
75
+
76
+
```
77
+
gulp trust-dev-cert
78
+
```
76
79
77
-
Switch to your console, make sure you are still in the **helloworld-webpart** directory and enter the following command to build and preview your web part:
80
+
Now that we have installed the developer certificate, enter the following command in the console to build and preview your web part:
78
81
79
82
```
80
83
gulp serve
81
84
```
82
85
83
86
This command will execute a series of gulp tasks to create a local, Node-based HTTPS server on 'localhost:4321' and launch your default browser to preview web parts from your local dev environment.
84
87
85
-
The client-side toolchain uses HTTPS endpoint by default. However, since a default certificate is not configured for the local dev environment, your browser will report a certificate error. Depending on the browser you are using, you will need to add exception (for example, Mozilla Firefox) or click Advanced and select to proceed to the website (for example, Microsoft Edge or Google Chrome).
86
-
87
88

88
89
89
90
SharePoint client-side development tools use [gulp](http://gulpjs.com/) as the task runner to handle build process tasks such as:
Copy file name to clipboardExpand all lines: docs/spfx/web-parts/get-started/connect-to-sharepoint.md
+1-7Lines changed: 1 addition & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -77,13 +77,7 @@ You should see the following in the web part:
77
77
78
78
Go to **workbench.aspx** hosted in SharePoint. The full URL is https://your-sharepoint-site-url/Shared%20Documents/workbench.aspx.
79
79
80
-
By default, your browser is configured not to load scripts from localhost. Workbench will notify you if that is the case as shown in the following image. This is due to loading scripts over HTTP while connected to a page via HTTPS.
81
-
82
-

83
-
84
-
To execute local scripts, in the Chrome browser, click the grey shield in the right side of the address bar to load unsafe scripts.
85
-
86
-

80
+
>**Note:** If you do not have the SPFx developer certificate installed, then Workbench will notify you that it is configured not to load scripts from localhost. Execute `gulp trust-dev-cert` command in your project directory console to install the developer certificate.
87
81
88
82
You should now see your SharePoint site URL in the web part now that page context is available to the web part.
Copy file name to clipboardExpand all lines: docs/spfx/web-parts/get-started/serve-your-web-part-in-a-sharepoint-page.md
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -88,6 +88,8 @@ This will deploy the client-side solution package. Since this is a full trust cl
88
88
89
89
Choose **Deploy**
90
90
91
+
>**Note:** If package deployment fails, then you may be using a normal tenant. Make sure you [set up your Office 365 tenant](../../set-up-your-developer-tenant) to have First Release options enabled or use a Office 365 Developer Tenant.
<Itemtext="Overview"url="spfx/sharepoint-framework-overview"SEODescription="The SharePoint Framework provides a modern developer experience for extending SharePoint."/>
5
5
<Itemtext="Tools and libraries"url="spfx/tools-and-libraries"SEODescription="Learn about the tools and libriaries you will need to use to build your SharePoint Framework solutions."/>
6
-
<Itemtext="Set up your Office 365 developer tenant"url="spfx/set-up-your-developer-tenant"SEODescription="Set up an Office 365 developer tenant so that you can test and debug your SharePoint client-side web parts" />
6
+
<Itemtext="Set up your Office 365 tenant"url="spfx/set-up-your-developer-tenant"SEODescription="Set up an Office 365 tenant so that you can test and debug your SharePoint client-side web parts" />
7
7
<Itemtext="Set up your development environment"url="spfx/set-up-your-development-environment"SEODescription="Set up and configure your development environment to build SharePoint client-side web parts" />
8
8
<Itemtext="SharePoint Framework Toolchain"url="spfx/sharepoint-framework-toolchain"SEODescription="The SharePoint Framework toolchain is the set of build tools, framework packages, and other items that manage building and deploying your client side projects." />
0 commit comments