honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added sample.json, fixed readme

This commit is contained in:
Hugo Bernier 2023-06-12 11:35:28 -04:00
parent 38d1eae34c
commit 3c6036e977
2 changed files with 70 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
samples/react-invoice-generator/README.md
View File

@ -1,9 +1,8 @@
# Invoice Generator Webpart # Invoice Generator
## Summary ## Summary
SPFx Invoice Generator Webpart using PnP JS SPFx Invoice Generator Web part using PnP JS allows users to create invoices for different clients or customers. Users can add items to the invoice using add item button, and the application calculates the subtotal, tax, and total amount. The application also generates PDF versions of the invoices. To obtain customer names and addresses, the application retrieve data from a SharePoint list and present them in dropdown menus for use in the application. The user interface components are designed and implemented using the Fluent UI library. Additionally, the @react-pdf/renderer library is utilized to generate the PDF versions of the invoices. Company Logo, Company Name, Address and Tax rate can be updated using web part properties.
allows users to create invoices for different clients or customers. Users can add items to the invoice using add item button, and the application calculates the subtotal, tax, and total amount. The application also generates PDF versions of the invoices. To obtain customer names and addresses, the application retrieve data from a SharePoint list and present them in dropdown menus for use in the application. The user interface components are designed and implemented using the Fluent UI library. Additionally, the @react-pdf/renderer library is utilized to generate the PDF versions of the invoices. Compnay Logo, Company Name, Address and Tax rate can be updated using webpart properties.
![Configure Invoice Generator](./assets/configureWebpart.PNG) ![Configure Invoice Generator](./assets/configureWebpart.PNG)
@ -12,10 +11,9 @@ allows users to create invoices for different clients or customers. Users can ad
List needed to configure to make the app work List needed to configure to make the app work
![Invoice Generator List ](./assets/invoiceList.PNG) ![Invoice Generator List ](./assets/invoiceList.PNG)
PDF genreated using Downlaod Invoice PDF button PDF generated using Download Invoice PDF button
![Invoice Generator PDF ](./assets/invoicePDF.PNG) ![Invoice Generator PDF ](./assets/invoicePDF.PNG)
## Compatibility ## Compatibility
| :warning: Important | | :warning: Important |
@ -36,19 +34,19 @@ PDF genreated using Downlaod Invoice PDF button
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) * [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 developer tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant) * [Office 365 developer tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
## Prerequisites ## Prerequisites
To use the SPFX Invoice Generator app, you will need: To use the SPFX Invoice Generator app, you will need:
A custom list on the current SharePoint site with the following columns: A custom list on the current SharePoint site with the following columns:
- Title (single line of text) renamed to customerName in the screenshot. Internal Name - Title
- billTo (multiple lines of text)
* Title (single line of text) renamed to customerName in the screenshot. Internal Name - Title
* billTo (multiple lines of text)
## Contributors ## Contributors
- [Rishabh Shukla](https://github.com/rishabhshukla12) * [Rishabh Shukla](https://github.com/rishabhshukla12)
## Version history ## Version history
@ -58,26 +56,16 @@ A custom list on the current SharePoint site with the following columns:
## Minimal Path to Awesome ## Minimal Path to Awesome
- Clone this repository * Clone this repository
- Ensure that you are at the solution folder * Ensure that you are at the solution folder
- in the command-line run: * in the command-line run:
- `npm install` * `npm install`
- `gulp serve` * `gulp serve`
## 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.**
---
## References ## References
- [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant) * [Getting started with SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development * [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development
## Help ## Help
@ -85,13 +73,12 @@ We do not support samples, but we this community is always willing to help, and
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. 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.
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-chatgpt-app&template=bug-report.yml&sample=react-chatgpt-app&authors=@smaity%20@joaojmendes&title=react-chatgpt-app%20-%20). 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-invoice-generator&template=bug-report.yml&sample=react-invoice-generator&authors=@rishabhshukla12&title=react-invoice-generator%20-%20).
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-chatgpt-app&template=question.yml&sample=react-chatgpt-app&authors=@smaity%20@joaojmendes&title=react-chatgpt-app%20-%20). 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-invoice-generator&template=question.yml&sample=react-invoice-generator&authors=@rishabhshukla12&title=react-invoice-generator%20-%20).
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-chatgpt-app&template=question.yml&sample=react-chatgpt-app&authors=@smaity%20@joaojmendes&title=react-chatgpt-app%20-%20). 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-invoice-generator&template=question.yml&sample=react-invoice-generator&authors=@rishabhshukla12&title=react-invoice-generator%20-%20).
**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.**
**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.**
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-invoice-generator" /> <img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-invoice-generator" />

50
samples/react-invoice-generator/assets/sample.json Normal file
View File

@ -0,0 +1,50 @@
[
{
"name": "pnp-sp-dev-spfx-web-parts-react-invoice-generator",
"source": "pnp",
"title": "Invoice Generator",
"shortDescription": "SPFx Invoice Generator Web part using PnP JS allows users to create invoices for different clients or customers.",
"url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-invoice-generator",
"downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-invoice-generator",
"longDescription": [
"SPFx Invoice Generator Web part using PnP JS allows users to create invoices for different clients or customers."
],
"creationDateTime": "2023-06-12",
"updateDateTime": "2023-06-12",
"products": [
"SharePoint"
],
"metadata": [
{
"key": "CLIENT-SIDE-DEV",
"value": "React"
},
{
"key": "SPFX-VERSION",
"value": "1.16.1"
}
],
"thumbnails": [
{
"type": "image",
"order": 100,
"url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-invoice-generator/assets/YOUR-IMAGE-NAME-HERE",
"alt": "Web Part Preview"
}
],
"authors": [
{
"gitHubAccount": "rishabhshukla12",
"pictureUrl": "https://github.com/rishabhshukla12.png",
"name": "Rishabh Shukla"
}
],
"references": [
{
"name": "Build your first SharePoint client-side web part",
"description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.",
"url": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part"
}
]
}
]