README.md

October 20, 2024 ยท View on GitHub

NewsAI Logo

๐Ÿš€ NewsAI: Where AI Meets Breaking News! ๐ŸŒŸ

Buckle up, news junkies! We're about to take you on a wild ride through the information superhighway! ๐ŸŽข

GitHub stars GitHub forks GitHub watchers GitHub contributors GitHub last commit Documentation Status

๐ŸŽญ What's All the Fuss About?

Imagine if CNN, Reddit, and a fortune-teller had a baby, and that baby was raised by AI. That's NewsAI! We're not just aggregating news; we're revolutionizing how you experience information:

  • ๐Ÿ”ฎ Gemini-Powered Insights: Google's Gemini AI is our crystal ball!
  • ๐Ÿง  BERT-Based Sentiment Analysis: We don't just read news; we feel it in our circuits!
  • ๐Ÿš€ FastAPI Backend: So fast, it breaks the space-time continuum!
  • ๐Ÿ–ฅ๏ธ Streamlit Dashboard: Where data visualization meets modern art!
  • ๐Ÿƒ MongoDB: Because our data is too cool for tables!

๐ŸŽฌ See It or Don't Believe It!

Deployment link : https://news-ai-dashboard.streamlit.app/

Demo Video
Warning: This video may cause uncontrollable desire to code! ๐Ÿค“

๐Ÿš€ Quick Start: 0 to Hero in 3... 2... 1...

# Clone this bad boy
git clone https://github.com/Multiverse-of-Projects/NewsAI.git

# Enter the matrix
cd NewsAI

# Install magical dependencies
pip install -r requirements.txt

# Add neccessary creds in .env file
create an .env file with api keys and all

# Add python path and run streamlit from src/dashboard/
streamlit run app.py

# If you want to run only the pipeline.py
python -m src.pipeline

# If you want to Unleash your creativity
git checkout -b feature/skynet-integration

# Start coding like you're trying to prevent Y2K!
# for reference my python version == 3.12.7

๐ŸŒˆ Contribution: Join Our Avengers of Code!

  1. ๐Ÿด Fork (the repo, not your dinner)
  2. ๐ŸŒฟ Branch (create one, don't climb one)
  3. ๐Ÿ’ก Commit (changes, not crimes)
  4. ๐Ÿš€ Push (to the repo, not your luck)
  5. ๐ŸŽ‰ PR (Pull Request, not Public Relations)

๐Ÿ† Wall of Fame: Our Code Wizards

These legends write code that makes Shakespeare look like a casual blogger!

๐Ÿ“š Documentation: The Sacred Texts

Our docs are so good, they're basically the eighth wonder of the world. Check them out on Read the Docs!

๐ŸŽจ Our Tech Palette: Tools of Mass Construction

  • ๐Ÿง  Gemini AI: For insights sharper than a samurai's sword
  • ๐Ÿค– BERT: Sentiment analysis that can read between the lines (and emojis)
  • ๐Ÿš€ FastAPI: Because life's too short for slow APIs
  • ๐Ÿ–ฅ๏ธ Streamlit: Making dashboards sexier than a sports car
  • ๐Ÿƒ MongoDB: NoSQL? More like YesQL to all our data needs!

๐Ÿ“ฌ Reach Out and Touch Code

๐Ÿ“œ License to Thrill

This project is licensed under the MIT License - see the LICENSE.md file for details. It's basically a license to code with reckless abandon!



May your code be bug-free and your coffee be strong! ๐Ÿš€โ˜•