README.md
October 20, 2024 ยท View on GitHub
๐ NewsAI: Where AI Meets Breaking News! ๐
Buckle up, news junkies! We're about to take you on a wild ride through the information superhighway! ๐ข
๐ญ 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/
๐ 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!
- ๐ด Fork (the repo, not your dinner)
- ๐ฟ Branch (create one, don't climb one)
- ๐ก Commit (changes, not crimes)
- ๐ Push (to the repo, not your luck)
- ๐ 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
- ๐ง Email: patel.devasy.23@gmail.com (We read faster than we code!)
- ๐ฌ Discord: Join our server (Where we debate tabs vs. spaces)
๐ 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! ๐โ