Skip to content

docs: clarify dashboard must be run from project root (fixes #9)#10

Open
sakicansev wants to merge 1 commit intoBitPolito:masterfrom
sakicansev:fix/readme-run-instructions
Open

docs: clarify dashboard must be run from project root (fixes #9)#10
sakicansev wants to merge 1 commit intoBitPolito:masterfrom
sakicansev:fix/readme-run-instructions

Conversation

@sakicansev
Copy link
Copy Markdown

What this PR does

Adds a note to the README clarifying that the Streamlit dashboard
must be run from the project root, not from inside the dashboard/ folder.

Running from inside the folder causes a FileNotFoundError because
the app uses a relative path dashboard/bitpolito_logo.png.

Changes

  • Added pip instructions for running the dashboard
  • Added a warning about the correct working directory

Fixes #9

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README missing instruction: app must be run from project root, not dashboard folder

1 participant