Skip to content

Commit

Permalink
updated documentation and added support for teams
Browse files Browse the repository at this point in the history
  • Loading branch information
thenikhilk committed Oct 27, 2019
1 parent 324424d commit e1342dc
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 5 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# SharePoint Instagram feed Webpart
# SharePoint Instagram feed Web Part

[![Build Status](https://dev.azure.com/TheNikhilK/TheNikhilK/_apis/build/status/SharePoint%20Instagram%20Web%20Part?branchName=master)](https://dev.azure.com/TheNikhilK/TheNikhilK/_build/latest?definitionId=3&branchName=master) [![Release Status](https://vsrm.dev.azure.com/TheNikhilK/_apis/public/Release/badge/bb0a4e04-afca-4551-8acd-9a8a4ee21621/3/3)](https://vsrm.dev.azure.com/TheNikhilK/_apis/public/Release/badge/bb0a4e04-afca-4551-8acd-9a8a4ee21621/3/3)

![Logo](documentation/assets/tnk-sp-ig-feed.png "Logo")

This webpart enables Office 365 SharePoint users to embed instagram feeds from any public Instagram account to SharePoint pages seamlessly with NO NEED for registering any ACCESS_KEY, TOKEN or client applications.
This web part enables Office 365 SharePoint users to embed instagram feeds from any public Instagram account to SharePoint pages seamlessly with **NO NEED** for registering any **ACCESS_KEY**, **TOKEN** or **client applications**.

## Documentation

- [Installation Guide](documentation/installation-guide.md "Installation Guide")
- [Developer Guide](documentation/developer-guide.md "Developer Guide")

## Nest Steps
## Demo

![Demo](documentation/assets/demo.gif "Demo")

## Next Steps

App to be soon available from Microsoft Store.

Expand Down
42 changes: 41 additions & 1 deletion documentation/developer-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
# Developer Guide

TBD
## Setup

To setup download/clone the repo and run the following commands at root

``` powershell
npm install
npm install -g yo gulp
npm install -g @microsoft/generator-sharepoint
```

Additional info for environment setup is available at [link](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-development-environment "link").

## Build

``` powershell
gulp clean
gulp bundle
```

## Debug

``` powershell
gulp serve
```

This will launch the workbench where you can debug you web part.

## Bundle and Package

``` powershell
gulp bundle --ship
gulp package-solution --ship
```

Files to deploy will be available at path `temp\deploy` and the package(*.sppkg) will be available at `sharepoint\solution` path.

Make sure to update the `cdnBasePath` at `config\write-manifests.json` before deployment to the location where you have deployed your assets.

Additional info for deployment is available at [link](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/deploy-web-part-to-cdn "link").

SPFx Documentation: [link](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/sharepoint-framework-overview "link")
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
// https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
"requiresCustomScript": false,
"supportedHosts": [
"SharePointWebPart"
"SharePointWebPart",
"TeamsTab"
],
"preconfiguredEntries": [
{
Expand Down

0 comments on commit e1342dc

Please sign in to comment.