This guide will help you set up and run the project on both Windows and Mac. It includes steps for complete beginners who may not have Git or Python installed.
- Windows:
- Download from git-scm.com and run the installer.
- Follow the default options.
- Mac:
- Open Terminal and run:
xcode-select --install(or install from git-scm.com)
- Open Terminal and run:
- Windows:
- Download from python.org.
- Run the installer. Check the box that says "Add Python to PATH".
- Mac:
- Open Terminal and run:
brew install python(if you have Homebrew), or download from python.org.
- Open Terminal and run:
- Usually comes with Python. To check, run:
pip --version
Open Terminal (Mac) or Command Prompt (Windows) and run:
git clone <your-repo-url>
cd data-analysispython -m venv .venv
.venv\Scripts\activatepython3 -m venv .venv
source .venv/bin/activateWith the virtual environment activated, run:
pip install -r requirements.txtThe entry file is main.py. To start the project, run:
uv run main.pyuv run main.pyIf you do not have uv installed, install it with:
pip install uvAfter running the command above, the app will start. Open your browser and go to the address shown in the terminal (usually http://127.0.0.1:8050).
- If you get a
ModuleNotFoundError, make sure you activated your virtual environment and installed all dependencies. - If you have permission errors, try running your terminal as administrator (Windows) or use
sudo(Mac, only if needed).
- Deactivate virtual environment:
deactivate - Update dependencies:
pip install --upgrade -r requirements.txt - Check Python version:
python --versionorpython3 --version
If you have any issues, please ask your team for help!