https://github.com/shagun122/solar-ai-bot
This is an AI-powered assistant that provides expert insights on solar energy, including solar panel technology, installation, maintenance, cost analysis, regulations, and market trends.
https://github.com/shagun122/solar-ai-bot
ai huggingface solar-panel streamlit
Last synced: 2 months ago
JSON representation
This is an AI-powered assistant that provides expert insights on solar energy, including solar panel technology, installation, maintenance, cost analysis, regulations, and market trends.
- Host: GitHub
- URL: https://github.com/shagun122/solar-ai-bot
- Owner: shagun122
- Created: 2025-02-15T17:26:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-15T17:31:46.000Z (over 1 year ago)
- Last Synced: 2025-02-15T18:29:23.043Z (over 1 year ago)
- Topics: ai, huggingface, solar-panel, streamlit
- Language: Python
- Homepage: https://huggingface.co/spaces/shrishagun/solar-ai-assistant
- Size: 4.88 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# βοΈ Solar Industry AI Assistant
This is an **AI-powered assistant** that provides expert insights on solar energy, including **solar panel technology, installation, maintenance, cost analysis, regulations, and market trends**. **https://huggingface.co/spaces/shrishagun/solar-ai-assistant**
π **Powered by OpenRouter API** with **Gemini Flash Lite 2.0 (Free).**
---
## **π Features**
- π Provides accurate information about **solar energy**
- β‘ Uses **OpenRouter AI (Gemini 2.0 Flash Lite - Free)**
- π‘ Secure API key handling with **dotenv**
- π¨ Interactive UI with **Streamlit**
---
## **π Installation & Setup (Localhost)**
### **1οΈβ£ Clone the Repository**
```bash
git clone https://github.com/YOUR_GITHUB_USERNAME/solar-ai-assistant.git
cd solar-ai-assistant
```
### **2οΈβ£ Create a Virtual Environment (Recommended)**
```bash
python -m venv venv
```
Activate the virtual environment:
- **Windows**:
```bash
venv\Scripts\activate
```
- **Mac/Linux**:
```bash
source venv/bin/activate
```
### **3οΈβ£ Install Dependencies**
```bash
pip install -r requirements.txt
```
### **4οΈβ£ Set Up API Key**
1. Create a **`.env`** file in the project root.
2. Add your **OpenRouter API Key** inside `.env`:
```bash
OPENROUTER_API_KEY=your_openrouter_api_key_here
```
### **5οΈβ£ Run the Application**
```bash
streamlit run app.py
```
The app will launch in your browser at **`http://localhost:8501/`** π
---
## **π Deployment**
### **Deploy on Hugging Face Spaces**
1. Go to **[Hugging Face Spaces](https://huggingface.co/spaces)**
2. Create a new **Streamlit** space
3. Upload the following files:
- `app.py`
- `requirements.txt`
4. **Set API Key** in **Settings β Secrets**
5. Restart the space, and itβs live! π
---
## **π‘ Security Best Practices**
- β
**DO NOT** commit your `.env` file
- β
Add `.env` to `.gitignore`:
```
.env
```
---
## **π¨βπ» Contributing**
Feel free to fork and submit **pull requests**! Contributions are welcome.
---
## **π§ Contact**
For issues or suggestions, create a **GitHub Issue** or email **awareindia12@gmail.com**.
---
π― **Now, you're all set to build and deploy your AI-powered Solar Assistant!** βοΈπ