Skip to content

SETUP.md

Latest commit

 

History

History
69 lines (45 loc) · 1.4 KB

SETUP.md

File metadata and controls

69 lines (45 loc) · 1.4 KB

Quick Setup Guide

🚀 Quick Start (5 minutes)

1. Get Reddit API Credentials

  1. Visit Reddit App Preferences
  2. Click "Create App" → Choose "script"
  3. Copy your Client ID and Secret

2. Configure Environment

cp env.example .env
# Edit .env with your Reddit credentials

3. Start the Application

docker-compose up --build

4. Access the Dashboard

🎯 First Analysis

  1. Go to the Analysis page
  2. Select "Subreddit" analysis
  3. Enter a subreddit name (e.g., "python")
  4. Click "Start Analysis"
  5. View results on the Dashboard

🔧 Troubleshooting

Reddit API Issues

  • Ensure your Reddit app is set to "script" type
  • Check that Client ID and Secret are correct
  • Verify Reddit account is not restricted

Docker Issues

# Clean up and restart
docker-compose down -v
docker-compose up --build

Memory Issues

  • Ensure at least 2GB RAM available
  • Close other applications if needed

📚 Next Steps

  • Read the full README.md for detailed documentation
  • Explore the API documentation at http://localhost:8000/docs
  • Try analyzing different subreddits and keywords
  • Check out the sentiment trends and statistics

Need help? Check the troubleshooting section in the main README or create an issue.