Anatomy of a Dash component library
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript, julia, python, r, webpack
- Domain
- documentation
Research direction
Start at the root of the generated component library and review the listed JS, webpack, npm, R, Julia, PyPI, and documentation files. Create a Markdown guide grouped by Python, R, JavaScript, and Julia that explains each file and whether a beginner needs to modify it; the guide is done when the root files and their roles are covered.
Written by the indexing model from the issue text.
Description
When we look at the root of the generated component library, we notice a lot of files from various aspects of Dash. We will have files related to
- JS (
.eslintrc,src/,index.html), - webpack (
webpack.config.js,webpack.serve.config.js), - npm (
package.json,.npmignore,package-lock.json), - R (
.Rbuildignore,R/,inst/deps/), - Julia (
src/), - pypi (
MANIFEST.in,setup.py) - docs (.md files)
- etc.
Although you get a hang of what each file does after a while, I think it might be a bit disorienting for a beginner, especially since the files span 4 different languages. It would be nice to have a md doc describing what each file does, whether you will need to worry about it not. The doc could be grouped by language (Python, R, JS, Julia).
Thoughts on this?
- Dominant language
- Python
- Stars
- 294
- Forks
- 196
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from plotly/dash-component-boilerplate
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
plotly/dash-component-boilerplate#173 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
plotly/dash-component-boilerplate#170 · 1 comment ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 45/100
plotly/dash-component-boilerplate#166 · 1 reaction ·
-
Running build Open
Difficulty 3/5 1-2 days Newbie friendliness 30/100
All issues in plotly/dash-component-boilerplate
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
xinnan-tech/xiaozhi-fde-talk#263 ·
-
rules
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
huggingface/Repo2RLEnv#163 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
huggingface/sentence-transformers#4074 ·
-
comp/dashboard invalid P3
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
NousResearch/hermes-agent#121143 ·