Skip to content

📖 The Official Dash Userguide & Documentation

License

Notifications You must be signed in to change notification settings

demonintherough/dash-docs

 
 

Repository files navigation

Dash Userguide

The Dash User Guide: everything that you need to know to be productive with Dash.

The Dash User Guide is hosted online at: https://dash.plotly.com. A PDF version is also available.

Running an app locally

To run an app locally:

  1. (optional) create and activate new virtualenv or conda env:
pip install virtualenv
virtualenv venv
source venv/bin/activate

or, with conda:

conda create --yes -n dash_docs
source activate dash_docs
  1. pip install -r requirements.txt
  2. gunicorn --preload index:server

Alternatively, for development purposes, you can run: while true; do IGNORE_DASH_BIO=true python index.py; sleep 2; done

The while true loop restarts Dash when there's syntax errors outside of the callbacks, and IGNORE_DASH_BIO=true constant prevents the loading of heavy Dash Bio examples, which makes hotreloading faster.

  1. open http://127.0.0.1:8000 in your browser

on Windows systems waitress can be a replacement for gunicorn

  1. pip install waitress
  2. waitress-serve --listen=*:8000 index:server
  3. open http://127.0.0.1:8000 in your browser

Contributing

PRs accepted! The Dash user guide is itself a Dash app. Each file in tutorial represents a "chapter" of the docs.

Changes to master will get deployed automatically.

About

📖 The Official Dash Userguide & Documentation

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 60.9%
  • R 30.5%
  • Julia 4.0%
  • JavaScript 2.9%
  • CSS 1.3%
  • Roff 0.4%