https://github.com/umairazmat/profit-compass
Guiding you to profitable business decisions.
https://github.com/umairazmat/profit-compass
Last synced: 5 months ago
JSON representation
Guiding you to profitable business decisions.
- Host: GitHub
- URL: https://github.com/umairazmat/profit-compass
- Owner: umairazmat
- Created: 2024-11-06T03:05:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-07T03:12:59.000Z (about 1 year ago)
- Last Synced: 2025-04-04T20:47:26.790Z (8 months ago)
- Size: 1.95 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Profit Compass “Guiding you to profitable decisions.”
## Description
Profit Compass is a web application that helps you make profitable decisions by providing you with insights and predictions based on your data. It uses AI to analyze your data and provide you with actionable insights that can help you make better decisions.
## Getting Started
### Prerequisites
- Python 3.7 or higher
- Pip (Python package manager)
### Installation
## Clone the repository:
````bash
git clone https://github.com/umairazmat/Profit-Compass
cd Profit-Compass
## Set up a virtual environment:
```bash
python -m venv Profit-Compass
````
## For Windows:
```bash
.\Profit-Compass\Scripts\activate
```
## For Mac/Linux:
```bash
source Profit-Compass/bin/activate
```
## Install the required packages:
```bash
pip install -r requirements.txt
```
## Create a .env file in the root directory with the following content:
```bash
OPENAI_API_KEY=your_actual_api_key
OPENAI_API_BASE=your_actual_api_key
GROQ_API_KEY=your_actual_api_key
```
## Run the application:
```bash
streamlit run .\app.py
```
## if script not run :
```bash
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
```
## Troubleshooting
- Verify that API keys are correctly set in the `.env` file.
- Ensure that the Python version and dependencies match the requirements.
---
## Contributing
1. **Fork the repository**
2. **Create a feature branch**
```bash
git checkout -b feature/YourFeature
```
3- **Commit your changes**
```bash
git commit -m 'Add new feature'
```
4- **Push to the branch**
`bash
git push origin feature/YourFeature
`bash
5- **Open a Pull Request**
## 📞 Contact
For queries or collaboration, please reach out at **hello@umairazmat.com**.