Skip to content
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

Jump to bottom

Minor updates to the README.md #118

Merged
merged 3 commits into from
Feb 22, 2021
Merged

Minor updates to the README.md #118

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a8d29b
Update cookiecutter link to "gh:..."
Feb 15, 2021
2b37cd4
Move up some links
Feb 15, 2021
94697c8
Refactor "More Resources" section
Feb 15, 2021
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
21 changes: 14 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This repository contains a [Cookiecutter](https://github.com/audreyr/cookiecutter) template to create your own Dash components.

- New to Dash? Check out the [official Dash Documentations](https://dash.plotly.com)
- If it's the first time creating a Dash component, start with our [React guide for Python developers](https://dash.plotly.com/react-for-python-developers)
- Need help with your component? Create a post on the [Dash Community Forum](https://community.plotly.com/c/dash)

## Usage

To use this boilerplate:
Expand All @@ -14,7 +18,7 @@ To use this boilerplate:
[Node.js/npm is also required.](https://nodejs.org/en/)
2. Run cookiecutter on the boilerplate repo:
```
$ cookiecutter https://github.com/plotly/dash-component-boilerplate.git
$ cookiecutter gh:plotly/dash-component-boilerplate
```
3. Answer the questions about the project.
- `project_name`: This is the "human-readable" name of your project. For example, "Dash Core Components".
Expand All @@ -39,10 +43,13 @@ to generate the components in the `build:backends` script of the generated

## More Resources

- Learn more about Dash: https://dash.plotly.com
- Questions about this project? Create an issue: https://github.com/plotly/dash-component-boilerplate/issues/new
- Found a bug or have a feature request? [Create an issue](https://github.com/plotly/dash-component-boilerplate/issues/new)
- Watch the [component boilerplate repository](https://github.com/plotly/dash-component-boilerplate) to stay informed of changes to our components.
- [React guide for Python developers](https://dash.plotly.com/react-for-python-developers)
- Need help with your component? View the Dash Community Forum: https://community.plotly.com/c/dash
- Examples of Dash component libraries include `dash-core-components`: https://github.com/plotly/dash-core-components and `dash-html-components`: https://github.com/plotly/dash-html-components.
- To get a feel for what's involved in creating a component, read through the [README.MD file that this cookiecutter project generates](%7B%7Bcookiecutter.project_shortname%7D%7D/README.md)
- To get a feel for what's involved in creating a component, read the [README.md generated by this cookiecutter](%7B%7Bcookiecutter.project_shortname%7D%7D/README.md)
- Examples of Dash component libraries include:
- [`dash-core-components`](https://github.com/plotly/dash-core-components)
- [`dash-html-components`](https://github.com/plotly/dash-html-components)
- [`dash-cytoscape`](https://github.com/plotly/dash-cytoscape)
- [`dash-deck`](https://github.com/plotly/dash-deck)
- [Curated community-made components](https://plotly.com/dash-community-components/)