QUICKSTART.md

# Quick Start Guide - NLP Text Analysis Bot

**Developer: RSK World**
**Website: https://rskworld.in**
**Email: help@rskworld.in**
**Phone: +91 93305 39277**
**Year: 2026**

## Installation Steps

### 1. Install Python Dependencies
```bash
pip install -r requirements.txt
```

### 2. Download spaCy English Model
```bash
python -m spacy download en_core_web_sm
```

### 3. Download NLTK Data (Automatic)
The project will automatically download required NLTK data on first run, or you can download manually:
```python
import nltk
nltk.download('punkt')
nltk.download('stopwords')
nltk.download('wordnet')
nltk.download('vader_lexicon')
nltk.download('averaged_perceptron_tagger')
```

### 4. Validate Installation
```bash
python validate_project.py
```

### 5. Run the Application
```bash
python app.py
```

### 6. Access the Web Interface
Open your browser and navigate to:
```
http://localhost:5000
```

## Using the API

### Analyze Text
```bash
curl -X POST http://localhost:5000/api/analyze \
-H "Content-Type: application/json" \
-d '{"text": "Your text to analyze here"}'
```

### Calculate Text Similarity
```bash
curl -X POST http://localhost:5000/api/similarity \
-H "Content-Type: application/json" \
-d '{"text1": "First text", "text2": "Second text"}'
```

### Health Check
```bash
curl http://localhost:5000/api/health
```

## Troubleshooting

### Issue: Module not found
**Solution**: Run `pip install -r requirements.txt`

### Issue: spaCy model not found
**Solution**: Run `python -m spacy download en_core_web_sm`

### Issue: NLTK data missing
**Solution**: The project will download automatically, or run the NLTK download commands above

### Issue: Port already in use
**Solution**: Change the port in `app.py` (line 79) from `5000` to another port

## Testing

### Run Test Script
```bash
python test_analysis.py
```

### Run Example Usage
```bash
python example_usage.py
```

## Project Structure

```
nlp-text-analysis-bot/
├── app.py # Flask application
├── nlp_pipeline.py # Main pipeline
├── text_preprocessing.py # Text cleaning
├── sentiment_analysis.py # Sentiment analysis
├── entity_recognition.py # NER
├── semantic_understanding.py # Semantic analysis
├── text_summarization.py # Summarization
├── language_detection.py # Language detection
├── text_classification.py # Classification
├── readability_analysis.py # Readability
├── emotion_detection.py # Emotion detection
├── advanced_keywords.py # TF-IDF keywords
├── pos_tagging.py # POS tagging
├── text_similarity.py # Similarity calculation
├── templates/
│ └── index.html # Web interface
├── static/
│ ├── css/
│ └── js/
└── requirements.txt # Dependencies
```

## Support

For issues or questions:
- **Website**: https://rskworld.in
- **Email**: help@rskworld.in
- **Phone**: +91 93305 39277

---

**Developed by RSK World - 2026**