An open API service indexing awesome lists of open source software.

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.

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!** β˜€οΈπŸš€