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
The build and tests use webpack to compile all the source modules into one bundled module that can execute in the browser.
57
57
58
-
## Running the demo
59
-
Navigate to `/demo` directory
60
-
61
-
Install npm dependencies:
62
-
```
63
-
npm install
64
-
```
65
-
66
-
Serve the demo directory:
67
-
```
68
-
npm start
69
-
```
70
-
71
-
Open the address to view in the browser:
72
-
```
73
-
http://127.0.0.1:8080/
74
-
```
75
-
76
58
## Updating the documentation (For those with push permissions only)
77
59
First run the command to build the docs and open it to verify the changes are as expected.
78
60
79
61
```
80
62
npm run gulp -- build:docs
81
63
```
82
64
> There are errors during the TypeDoc compilation step due to some complication with modules however the documentation should still be generated. It's not clear if these are fixable by including more src files in the gulp task or if it's just the nature of TypeDoc lacking capabilities for this project structure.
83
-
84
-
If the docs are correct then you may publish them to gh-pages using this command
85
-
```
86
-
npm run gulp -- ghpages
87
-
```
88
-
89
-
## Known issues
90
-
Running demo fails with an error ERR_INVALID_REDIRECT
91
-
This happens due to version 10 of http-server. To solve the problem, please install [email protected] globally using:
Copy file name to clipboardExpand all lines: README.md
+7-10
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,14 @@ A client side library for embedding Power BI using JavaScript or TypeScript into
12
12
## Documentation
13
13
See the [Power BI embedded analytics Client APIs documentation](https://docs.microsoft.com/javascript/api/overview/powerbi/) to learn how to embed a Power BI report in your application and how to use the client APIs.
14
14
15
-
## Reference
16
-
See the [library reference](https://docs.microsoft.com/en-us/javascript/api/powerbi/powerbi-client/) for detailed information about classes, interfaces, types, etc.
15
+
## Code Docs
16
+
See the [code docs](https://learn.microsoft.com/en-us/javascript/api/powerbi/powerbi-client) for detailed information about classes, interfaces, types, etc.
17
+
18
+
## Sample Application
19
+
For examples of applications utilizing the `powerbi-client` library, please refer to the available samples in the [PowerBI-Developer-Samples repository](https://github.com/microsoft/PowerBI-Developer-Samples).
17
20
18
21
## Playground
19
-
The [playground](https://aka.ms/pbieplayground) is the home for Power BI embedded analytics, where you can get hands-on coding experience, embed your own reports, and interact with our client APIs to see instant results. In addition, you’ll find there our interactive showcases to get inspiration regarding how you can apply these features in your applications. Lastly, we’ve created a new learning center to help you find all the relevant samples, tutorials, and documentation you’ll need for a successful integration.
22
+
To explore and understand the capabilities of embedded analyticsin your applications, please visit the [Power BI Embedded Analytics Playground](https://playground.powerbi.com).
20
23
21
24
## Installation
22
25
@@ -55,10 +58,4 @@ This project welcomes contributions and suggestions. Most contributions require
55
58
56
59
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
57
60
58
-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments
59
-
60
-
## Support
61
-
62
-
-**Feature Requests:** Submit your ideas and suggestions to the [Fabric Ideas Portal](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fideas.fabric.microsoft.com%2F&data=05%7C02%7COr.Shemesh%40microsoft.com%7C72ccde64806a4ff4237b08dce610afa7%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638638206567959909%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C&sdata=f8%2Blboxk11RF0P4KelMaE7FEUfStuxgUkTc8HiuBxr0%3D&reserved=0), where you can also vote on ideas from other developers.
63
-
-**Bug Reports and Technical Assistance:** Visit the [Fabric Developer Community Forum](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcommunity.fabric.microsoft.com%2Ft5%2FDeveloper%2Fbd-p%2FDeveloper&data=05%7C02%7COr.Shemesh%40microsoft.com%7C66158ccfa9d0420897b808dce93e491f%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638641700929578580%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C0%7C%7C%7C&sdata=niYdcy8yLbG2X11WQhy3lkUgfboyYdT3oowYYfbtaDc%3D&reserved=0). Our team and community experts are ready to assist you.
64
-
-**Additional Support:** Contact your account manager or reach out to the [Fabric Support Team](https://support.fabric.microsoft.com/en-us/support/).
61
+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments
0 commit comments