Playground and get started #1240
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| title: Use Streamlit Playground in your browser | ||
| slug: /get-started/installation/streamlit-playground | ||
| --- | ||
|
|
||
| # Use Streamlit Playground in your browser | ||
|
|
||
| The fastest way to try out Streamlit is to try out our Playground! Streamlit Playground runs in your browser. Just visit the Playground, and a limited version of Streamlit loads as browser scripts. | ||
|
|
||
| Enjoy the following conveniences: | ||
|
|
||
| - Start playing with code right away, completely in your browser. | ||
| - No configuration. | ||
| - No command line. | ||
| - No application installations in your OS. | ||
|
There was a problem hiding this comment. You should make it clear that the playground doesn't support all Streamlit and Python features. There was a problem hiding this comment. I call this out in the There was a problem hiding this comment. I did the following:
|
||
|
|
||
| <Note> | ||
| The Playground is dependendant on your computer's resources because it runs _locally_ in your browser. The setup time can vary depending on your machine and internet connection. Although the Playground has everything you need to get started, to access the full awesomeness of Streamlit, see [Install Streamlit using command line](/get-started/installation/command-line) or [Install Streamlit using Anaconda Distribution](/get-started/installation/anaconda-distribution). | ||
| </Note> | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Because the Playground runs Streamlit in your browser, you should visit the Playground from a personal computer, not a mobile device. | ||
|
|
||
| ## Go to the Playground | ||
|
|
||
| 1. Go to [streamlit.io/playground](https://streamlit.io/playground). | ||
|
|
||
| 1. Wait for [`stlite`](https://github.com/whitphx/stlite) — a browser-based version of Streamlit — to load in your browser. | ||
|
There was a problem hiding this comment. I don't think you should mention stlite here. It's just confusing to the user. Instead just say something like: |
||
|
|
||
| This can take as little as a few seconds. However, it may take longer depending on your machine and internet. When Streamlit is done loading, an example app is displayed in the right panel. | ||
|
|
||
|  | ||
|
|
||
| ## Create a `Hello World` app | ||
|
There was a problem hiding this comment. Maybe tell users to click on different example apps and play with them first? |
||
|
|
||
| 1. From the "EXAMPLES" list, select "**Blank**." | ||
|
|
||
| 1. On the left, update the contents of the code editor to contain the following code: | ||
|
|
||
| ```python | ||
| import streamlit as st | ||
|
|
||
| st.title("Hello World") | ||
| ``` | ||
|
|
||
| A second or two after typing or pasting the code into the editor, the right panel will display the updated app. The code editor saves your edits whenever you pause from typing. Therefore, if you pause between keystrokes as you type a new line of code, you may see an error on the right because Streamlit executed an incomplete line. If this happens, just keep typing to complete the line(s) you are writing. When you pause again at the end of the line, Streamlit reruns the app. | ||
|
|
||
| ## What's next? | ||
|
|
||
| Read about our [Basic concepts](/get-started/fundamentals/main-concepts) and try out more commands in your app. | ||
|
There was a problem hiding this comment. I think "what's next" should point people toward installing Streamlit. Maybe something like: What's next?At this point you have two options:
|
||
|
|
||
| When you use the Streamlit Playground to work through the basic concepts, you can skip over any instructions to save your file or to select "**Rerun on save**." Streamlit Playground automatically saves your code when you pause from editing, as described above. Also, it is already configured to rerun on save. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW I think the previous wording made it clearer that if you're an expert you don't have to read the rest of these.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I moved the Playground up to highlight it further and added a little explainer blurb to emphasize to completely new or random passersby that the Playground is the easiet way to get a taste before choosing one of the local or cloud setup options below.