Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pstorozenko committed Oct 8, 2024
1 parent 68c58c8 commit bd71a06
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Check out our get started with `tapyr` [blog post](www.appsilon.com/post/introdu
### Using Devcontainer

To ensure a consistent development experience across all environments, we recommend using the [devcontainer](https://code.visualstudio.com/docs/remote/containers) configuration with Visual Studio Code or DevPod for container-based development.
If you prefer a local setup, follow the instructions below.

1. **Start the Devcontainer**: Open the project in VS Code and select "Reopen in Container" when prompted, or use the Command Palette (`Ctrl+Shift+P`) and choose "Remote-Containers: Reopen in Container". Alternatively, use [DevPod](https://devpod.sh/) following their instructions.
2. **Activate the virtual environment**:
Expand All @@ -51,12 +52,37 @@ For developers preferring a local setup without Devcontainer:
3. **Install dependencies**:
```sh
uv sync
source .venv/bin/activate
playwright install --with-deps
uv run playwright install --with-deps
```
4. **Run the application**:
```sh
uv run shiny run app.py --reload
```

*Attention*: Follow any additional steps prompted by `playwright install`.

More information on `uv` can be found in the [official documentation](https://docs.astral.sh/uv/).

### Setting Up Locally with `pip`

Although not recommended, you can set up the project using `pip`:

1. **Clone the repository** and navigate to it.
2. **Create a virtual environment**:
```sh
python -m venv .venv
source .venv/bin/activate
```
3. **Install package with dependencies**:
```sh
pip install -e ."[dev]"
playwright install --with-deps
```
4. **Run the application**:
```sh
shiny run app.py --reload
```

### Deployment on Posit Connect

Deploy your application to Posit Connect by:
Expand Down

0 comments on commit bd71a06

Please sign in to comment.