Development Setup

This guide explains how to set up the project for development and start contributing.

🔧 Requirements

Python 3.9 or newer
pip installed
Recommended: Virtual environment (venv) to isolate dependencies
Git for version control

📥 Clone Repository

git clone https://github.com/fabianfrank-ai/Stock_Market_Analyzer.git
cd Stock_Market_Analyzer

🛜 Create virtual environment(optional)

python -m venv venv
source venv/bin/activate  # Linux / macOS
venv\Scripts\activate     # Windows

📦 Install dependencies

pip install -r requirements.txt

▶️ Run the application

streamlit run stock_crypto/main.py

Note

If you encounter issues you can use the web-link as well: https://mainpy-ha8s7cwyirhspxlutcnpbv.streamlit.app

🌿 Recommended Workflow

Branching Strategy

main → stable branch, production-ready code
feature/ → new features
fix/ → bug fixes
docs/ → documentation updates

Commit Messages

Use clear, structured commit messages.

Merge Requests / Pull Requests

Develop on feature/fix branches
Open a merge request or pull request to main
Include description of changes and references to related issues if any

Notes for Developers

Always start the Streamlit app from main.py to ensure correct module loading.
Keep code modular: changes in core, GUI, or data should not break unrelated components.
Use /data_saved for testing with historical or example data.
Follow PEP8 coding conventions and include comments with references to official documentation where applicable.