Skip to content

Commit

Permalink
Update Dash documentation (#141)
Browse files Browse the repository at this point in the history
* update dash and cli note

* word
  • Loading branch information
bryannho authored Mar 8, 2024
1 parent f8602f1 commit ed1564a
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 3 deletions.
51 changes: 49 additions & 2 deletions doc/apps/dash.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,58 @@ gunicorn app:server run --bind 0.0.0.0:5000

Now, open [http://0.0.0.0:5000/](http://0.0.0.0:5000/) to see your app.


## Deploy

`````{tab-set}
````{tab-item} Web
__Deploy from the menu__
Once you have all your files, create a zip file.
To deploy a Dash app from the deployment menu, select the Dash option and follow the instructions:
![](../static/dash.png)
![](../static/dash.png)
````
````{tab-item} Command-line
__Try an example__
To download and deploy an example Dash application start by installing Ploomber Cloud and setting your API key:
```sh
pip install ploomber-cloud
ploomber-cloud key YOUR-KEY
```
```{tip}
If you don't have an API key yet, follow the [instructions here.](../quickstart/apikey.md)
```
Now, download an example. It will prompt you for a location to download the app. To download in the current directory, just press enter.
```sh
ploomber-cloud examples dash/clinical-analytics
```
```{note}
A full list of Dash example apps is available [here.](https://github.com/ploomber/doc/tree/main/examples/dash)
```
You should see a confirmation with instructions on deploying your app. Now, navigate to your application:
```sh
cd location-you-entered/clinical-analytics
```
__Deploy from the CLI__
Initialize and deploy your app with:
```sh
ploomber-cloud init
ploomber-cloud deploy --watch
```
````
`````
2 changes: 1 addition & 1 deletion doc/user-guide/cli.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Command-line interface

```{note}
Currently, Voila deployments are unsupported by the CLI. Environment variables and authentication are also unsupported. Expect support to be added soon.
Currently, authentication is unsupported by the CLI. Expect support to be added soon.
```

You can deploy applications using the command-line interface. First, install the package:
Expand Down

0 comments on commit ed1564a

Please sign in to comment.