sp-dev-fx-webparts/samples/react-manage-spfx-solutions.../README.md

73 lines
4.7 KiB
Markdown
Raw Normal View History

2021-11-07 00:52:25 -04:00
# Manage SPFx solution using ALM APIs
## Summary
This web part acts as a centralized place where admin can manage SPFx solutions present in their tenant using Application lifecycle Management(ALM) APIs and perform activities like Add, Deploy, Install, Retract, Uninstall & Remove apps.
### Tenant Appcatalog
![Application Lifecycle Management](./assets/SPFxALM.gif)
### Site Collection Appcatalog
![Application Lifecycle Management](./assets/SPFxALMSPAppcatalog.gif)
**Note:**
2021-04-26 02:08:59 -04:00
This web part is mainly build for tenant and SharePoint admins, since most of the operation requires administrator privileges.
2022-02-14 02:52:18 -05:00
## Compatibility
| :warning: Important |
|:---------------------------|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
![SPFx 1.10](https://img.shields.io/badge/SPFx-1.10.0-green.svg)
![Node.js v10 | v8](https://img.shields.io/badge/Node.js-v10%20%7C%20v8-green.svg)
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
2021-11-07 01:43:55 -04:00
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg)
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Local Workbench Compatible](https://img.shields.io/badge/Local%20Workbench-Compatible-green.svg)
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
2022-02-15 00:50:11 -05:00
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
## Minimal Path to Awesome
- git clone the repo
- `npm i`
- `gulp bundle --ship`
- `gulp package-solution --ship`
- Add to Site Collection App Catalog or Tenant AppCatalog and Install the App
- Add the web part to any page in the Site Collection
2022-02-15 00:50:11 -05:00
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
2023-02-18 22:58:44 -05:00
## Contributors
2023-02-18 22:58:44 -05:00
* [Ramakrishnan Raman](https://github.com/Ramakrishnan24689)
## Help
We do not support samples, but we this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-manage-spfx-solutions-alm") to see if anybody else is having the same issues.
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-manage-spfx-solutions-alm) and see what the community is saying.
2021-11-20 23:55:10 -05:00
If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-manage-spfx-solutions-alm&template=bug-report.yml&sample=react-manage-spfx-solutions-alm&authors=@Ramakrishnan24689&title=react-manage-spfx-solutions-alm%20-%20).
2021-11-20 23:55:10 -05:00
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-manage-spfx-solutions-alm&template=question.yml&sample=react-manage-spfx-solutions-alm&authors=@Ramakrishnan24689&title=react-manage-spfx-solutions-alm%20-%20).
2021-11-20 23:55:10 -05:00
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-manage-spfx-solutions-alm&template=question.yml&sample=react-manage-spfx-solutions-alm&authors=@Ramakrishnan24689&title=react-manage-spfx-solutions-alm%20-%20).
2021-11-07 02:11:17 -05:00
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
2021-12-20 10:25:30 -05:00
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-manage-spfx-solutions-alm" />