8000 Add Building.md by etpinard · Pull Request #2654 · plotly/plotly.js · GitHub
[go: up one dir, main page]
Skip to content

Add Building.md #2654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 23, 2018
Merged

Add Building.md #2654

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b0e9209
Add instruction to build with Angular CLI
TomDemulierChevret Jan 18, 2018
794a175
Fix inter section link & json example
TomDemulierChevret Jan 18, 2018
757a77c
first cut BUILDING.md file
etpinard May 23, 2018
54c2e60
fixups
etpinard May 23, 2018
3cf0c5c
add BUILDING.md to lower-case-only whitelist
etpinard May 23, 2018
9199e8e
clean up a few typos & style in BUILDING.md
alexcjohnson May 23, 2018
b8e1bea
update link & style in README.md
alexcjohnson May 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add instruction to build with Angular CLI
  • Loading branch information
@TomDemulierChevret @etpinard
TomDemulierChevret authored and etpinard committed May 23, 2018
commit b0e920962beb3b2455a09e981041e1ca95773cfe
35 changes: 35 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,41 @@ A repo that demonstrates how to build plotly.js with Webpack can be found [here]
...
```

#### Building plotly.js with Angular CLI

Currently Angular CLI use Webpack under the hood to bundle and build your Angular application.
Sadly it doesn't allow to override its Webpack config, and therefore to use the plugin mentioned in [Building plotly.js with Webpack](#building-plotly.js-with-webpack).
Without this plugin your build will fail when it tries to build glslify for GLSL plots.

Currently 2 solutions exists to circumvent this issue :
1) If you need to use GLSL plots, you can create a Webpack config from your Angular CLI projet with [ng eject](https://github.com/angular/angular-cli/wiki/eject).
This will allow you to follow the instructions regarding Webpack.
2) If you don't need to use GLSL plots, you can make a custom build containing only the required modules for your plots.
The clean way to do it with Angular CLI is not the method described in [Modules](#modules) but the following :
```typescript
// in the Component you want to create a graph
import * as Plotly from 'plotly.js';
```

```json
// in src/tsconfig.app.json
...
"compilerOptions": {
...
"paths": {
"plotly.js": [
// List here the modules you want to import
// this exemple is enough for scatter plots
"../node_modules/plotly.js/lib/core.js",
"../node_modules/plotly.js/lib/scatter.js"
]
}
...
}
...

```

## Bugs and feature requests

Have a bug or a feature request? Please first read the [issues guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md#opening-issues).
Expand Down
0