INSTALL.md

# Installation Guide
## ===================

**Author:** RSK World (https://rskworld.in)
**Year:** 2026

This guide provides detailed installation instructions for the Weather Chatbot application.

## Prerequisites

- Python 3.8 or higher
- pip (Python package installer)
- Git (optional, for cloning repository)
- OpenWeatherMap API key (free at https://openweathermap.org/api)
- OpenAI API key (optional, for enhanced NLP)

## Installation Methods

### Method 1: Standard Installation

1. **Clone the repository (or download ZIP)**
```bash
git clone https://github.com/rskworld/weather-chatbot.git
cd weather-chatbot
```

2. **Create virtual environment**
```bash
# Windows
python -m venv venv
venv\Scripts\activate

# macOS/Linux
python3 -m venv venv
source venv/bin/activate
```

3. **Install dependencies**
```bash
pip install --upgrade pip
pip install -r requirements.txt
```

4. **Configure environment variables**
```bash
# Copy example file
cp .env.example .env

# Edit .env file with your API keys
# OPENWEATHER_API_KEY=your_key_here
# OPENAI_API_KEY=your_key_here (optional)
```

5. **Run the application**
```bash
python app.py
# or
python run.py
```

6. **Access the application**
Open your browser and go to: `http://localhost:5000`

### Method 2: Docker Installation

1. **Build Docker image**
```bash
docker build -t weather-chatbot .
```

2. **Run container**
```bash
docker run -p 5000:5000 --env-file .env weather-chatbot
```

### Method 3: Docker Compose Installation

1. **Configure environment**
```bash
cp .env.example .env
# Edit .env file with your API keys
```

2. **Start services**
```bash
docker-compose up -d
```

3. **View logs**
```bash
docker-compose logs -f
```

4. **Stop services**
```bash
docker-compose down
```

## Post-Installation

### Verify Installation

1. **Check health endpoint**
```bash
curl http://localhost:5000/health
```

2. **Test API**
```bash
curl -X POST http://localhost:5000/chat \
-d "message=What is the weather in London?"
```

### Database Setup (Optional)

If using PostgreSQL or MySQL:

1. **Install database**
```bash
# PostgreSQL
sudo apt-get install postgresql postgresql-contrib

# MySQL
sudo apt-get install mysql-server
```

2. **Create database**
```sql
CREATE DATABASE weather_chatbot;
CREATE USER weatherbot WITH PASSWORD 'your_password';
GRANT ALL PRIVILEGES ON DATABASE weather_chatbot TO weatherbot;
```

3. **Update .env file**
```
DATABASE_URL=postgresql://weatherbot:your_password@localhost:5432/weather_chatbot
```

### Redis Setup (Optional)

1. **Install Redis**
```bash
# Ubuntu/Debian
sudo apt-get install redis-server

# macOS
brew install redis

# Start Redis
redis-server
```

2. **Update .env file**
```
REDIS_URL=redis://localhost:6379/0
CACHE_ENABLED=True
```

## Troubleshooting

### Common Issues

1. **Port already in use**
- Change PORT in .env file
- Or stop the process using port 5000

2. **Module not found errors**
- Ensure virtual environment is activated
- Run: `pip install -r requirements.txt`

3. **API key errors**
- Verify API keys in .env file
- Check OpenWeatherMap API key is valid

4. **Database connection errors**
- Verify DATABASE_URL in .env
- Check database server is running
- Verify credentials

5. **Redis connection errors**
- Check Redis server is running
- Verify REDIS_URL in .env
- Or disable caching: `CACHE_ENABLED=False`

## Production Deployment

See README.md for deployment instructions.

## Support

For installation help:
- Email: hello@rskworld.in
- Phone: +91 93305 39277
- Website: https://rskworld.in

---

**© 2026 RSK World. All rights reserved.**