Skip to content

Docs: Improve installation section and add troubleshooting guide #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,11 @@ Preswald tracks state and dependencies, so computations update only when needed

# **🚀 Getting Started**

```markdown
## **Installation**

First, install Preswald using pip. https://pypi.org/project/preswald/
First, install Preswald using pip (requires Python 3.7+)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*3.10, not 3.7

[Preswald on PyPI](https://pypi.org/project/preswald/)

```bash
pip install preswald
Expand All @@ -72,6 +74,12 @@ or
uv pip install preswald
```

**Note:**
If you encounter issues during installation, make sure you have an updated version of pip:

```bash
pip install --upgrade pip

![Demo GIF](assets/demo1.gif)

## **👩‍💻 Quick Start**
Expand Down Expand Up @@ -158,6 +166,7 @@ The first time you deploy, you'll be prompted to enter your **GitHub username**
Now your app is live, shareable, and scalable—without any extra setup.



## **🔧 Configuration**

Preswald uses `preswald.toml` for project settings and theming. It’s straightforward, and it makes your app look polished.
Expand Down Expand Up @@ -189,6 +198,25 @@ format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"

<br>

## 🛠 Troubleshooting

### Port already in use

If you run `preswald run` and see an error like:
```
OSError: [Errno 98] Address already in use
```
it means another application is already using the default port (8501).

You have two options:
- Stop the application that's using port 8501
- Or run Preswald on a different port:

```bash
preswald run --port 8502



## **📚 Documentation**

We’re here to help! Check out our full documentation at [Preswald Docs](https://docs.preswald.com/).
Expand Down