Skip to content

A Simple Webapp Built in Streamlit that displays a helpful cheatsheet

Notifications You must be signed in to change notification settings

zd123/simple-cheatsheet-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Web Apps in 5 mins

We built this in 5 mins https://simple-cheatsheet.streamlit.app/

First Steps

  1. Create a free Streamlit account
  2. Install Streamlit pip install streamlit.

Two Ways to do this

1. Locally via a git Repo

  1. Create a new repo, and clone it to your local machine.
  2. Create a README.md and streamlit_app.py and a requirements.txt file in that repo.
  3. Develop your app in the streamlit_app.py
  4. Add your requirements to the requirements.txt
  5. Add any instructions to the readme.
  6. Push your changes back to github.
  7. Run the app locally using streamlit run streamlit_app.py
  8. That will open the app locally, and you will see a deploy button in the top right. Click and follow the instructions. alt text

2. Online Via Streamlit Website

  1. Click create app (top right corner).
  2. Follow the prompts of linking your github, and then choose a template or a blank app.
  3. Change the domain and name of your app to whatever you want/is available.
  4. OPTIONAL: If you want to develop / code it in the cloud, Check the 'open github spaces' box, 0. Click Deploy.

-- Im going to do it local as well because im using cellphone for data.

Developing Locally

  1. First you need to get the files on your local machine... To do that open github by clicking the github icon (see image below). That will open the repo that was automatically created. Then clone that repo locally. alt text.
  2. You should now see all the files in your local machine.

How to run / develop streamlit on your own machine

I would first just do pip install streamlit, however, you can also run the requirements.

  1. Install the requirements

    $ pip install -r requirements.txt
    
  2. Run the app

    $ streamlit run streamlit_app.py
    

To run any streamlit app, you just type in streamlit run <name_of_app_file.py>. Above we are running the streamlit app that is coded in the streamlit_app.py file.

Editing your app

  1. Open the streamlit_app.py file in your favorite IDE text editor.
  2. Open the webpage of the streamlit cheat sheet alt text

Create a simple bio page.

  1. Create a new python file named bio.py.
  2. Open it and first, at the top include import streamlit as st.
  3. Add your name via any of the text methods listed in the cheat sheet. (My favorite is st.markdown("# Hi, I'm Zack")).
    0.0 Streamlit markdown uses Github Flavored Markdown. Here is a cheat sheet for github flavored markdown formatting

Add ons

https://streamlit.io/components

About

A Simple Webapp Built in Streamlit that displays a helpful cheatsheet

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages