Skip to main content

Getting Started

My tip

Welcome to Endash! Endash is the best way to deploy and share Dash apps.

And once you get going, you can take advantage of everything Endash offers:

  • user registration/control
  • user authentication and access control
  • large-file loading on app start
  • instant scaling
  • 24/7 availability
  • global edge deployment
  • Github deployment
  • long-term logs storage and retrieval
  • ...and more!

For now, here's the quickstart for launching your first Dash app on Endash.

Install the necessary packages and create the working directory.

pip install dash endash
mkdir myapp
cd myapp

Create a basic Dash app in the new directory.

myapp/app.py
from dash import Dash, html

app = Dash(__name__)
server = app.server

app.layout = html.Div("Hello, World!")

if __name__ == "__main__":
    app.run_server(
        debug=True,
        port=8050,
    )

Run your app locally to make sure it works:

python3 app.py

You can see your app running at http://localhost:8050

Take care

The app file must be named app.py, and you must include the line server = app.server -- otherwise Endash won't know what to run!

Finally, create an Endash account and deploy your app! It's that simple.

endash auth register
endash auth login
endash project create uniqueProjectName
endash app create uniqueAppName --project uniqueProjectName --deploy

You'll notice a new file was created - endash.toml. This contains a couple key details that Endash can use to easily redeploy on any changes.

Boom! Your app is now live at https://uniqueAppName.endash.cloud - check it out!

Let's redeploy with a small change to the app code. Update the app layout like:

myapp/app.py
from dash import Dash, html

app = Dash(__name__)

app.layout = html.Div("Hello, World! This was too easy!")

if __name__ == "__main__":
    app.run_server(
        debug=True,
        port=8050,
    )

Then redeploy like: 

endash deploy

Go to https://uniqueAppName.endash.cloud to see the changes.