https://github.com/chrisvoncsefalvay/cookiecutter-dash
A cookiecutter to generate Dash app skeletons.
https://github.com/chrisvoncsefalvay/cookiecutter-dash
cookiecutter-template dashboards plotly plotly-dash skeletons
Last synced: 7 months ago
JSON representation
A cookiecutter to generate Dash app skeletons.
- Host: GitHub
- URL: https://github.com/chrisvoncsefalvay/cookiecutter-dash
- Owner: chrisvoncsefalvay
- License: apache-2.0
- Created: 2019-09-09T12:02:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T21:14:42.000Z (over 2 years ago)
- Last Synced: 2025-03-21T15:10:57.938Z (7 months ago)
- Topics: cookiecutter-template, dashboards, plotly, plotly-dash, skeletons
- Language: Python
- Size: 53.7 KB
- Stars: 30
- Watchers: 2
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# cookiecutter-dash
    
A cookiecutter to generate Dash app skeletons.
* `Makefile` to generate Docker image (`make image`)
* Bootstrap integration and navbar chrome
* Dockerfile for deployment on ECS (see [instructions](https://www.chrisvoncsefalvay.com/2019/08/28/deploying-dash-on-amazon-ecs/))
* `DangerouslySetInnerHTML` included to allow you to inject pure HTML
* A choice of auto-generated licenses
## Usage
To build your Dash app, use
```
cookiecutter https://github.com/chrisvoncsefalvay/cookiecutter-dash
```
Parameters:
| Parameter | Default value | Description |
|-------------------------- |------------------------ |--------------------------------------------- |
| `project_name` | `My Dash application` | Project name – appears in description, etc. |
| `repo_name` | | Normalised repo name |
| `package_name` | | Normalised package name |
| `àuthor_name` | `Your name` | Package author's name |
| `author_email` | `you@are.aweso.me` | Package author's e-mail |
| `author_github_username` | `your_github_username` | Package author's github username |
| `description` | | Your project's short description |
| `version` | `0.1.0` | Project version |
| `license` | | Choice of a number of licenses. |
## Support
There's a [dedicated discussion thread on the Plotly Discourse server for `cookiecutter-dash`](https://community.plot.ly/t/the-fastest-way-to-get-started-building-a-dash-app-cookiecutter-dash/28568). For questions that aren't issues or bugs, you might want to go there.
If you detect a bug, please file an issue under the Issues tab.
## Contributing
Contributions are welcome! Go to the Issues tab to see where we need help. If you have a feature suggestion, please propose it as an issue before creating a pull request, so that it can be properly discussed. Thanks!