Skip to content

[DOCS ENHANCEMENT] Improve README Setup Instructions for Local Project Run #58

@samrat21saha

Description

@samrat21saha

[DOCS ENHANCEMENT] Improve README Setup Instructions for Local Project Run

📄 Description

The current README.md lacks clear and structured guidance for contributors on how to set up and run the project locally. Many new contributors face issues related to virtual environment activation, dependency installation, and running the Streamlit frontend successfully.

This issue proposes enhancing the README file to include:

  • Step-by-step local setup instructions
  • Python version and virtual environment details
  • Commands to install dependencies
  • Proper way to activate venv on different OS (Windows/macOS/Linux)
  • Instructions to run the Streamlit frontend
  • Troubleshooting section for common errors (e.g., streamlit not recognized, file path issues)

🔗 Related Program

This issue is raised under GSSoC (GirlScript Summer of Code) to improve contributor onboarding and local environment setup experience.

✅ Proposed Changes

  • Add a "Local Setup Guide" section in README.md
  • Include code snippets with PowerShell and Bash examples
  • Add notes for Python version management and dependency installation
  • Clarify correct directory structure and expected file names
  • Include sample output and localhost link for successful setup verification

🎯 Expected Outcome

A well-documented and beginner-friendly README.md that allows any contributor to:

  1. Clone the repository
  2. Set up the virtual environment properly
  3. Install dependencies
  4. Run the Streamlit app successfully without confusion

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions