https://github.com/xoxoharsh/red_alert
Red Alert is a notification system designed to keep users informed about critical news affecting their stock portfolio. In today's fast-paced market, staying updated on relevant information can be overwhelming with a flood of news from various sources.
https://github.com/xoxoharsh/red_alert
full-stack news notification prediction stock-market
Last synced: 3 months ago
JSON representation
Red Alert is a notification system designed to keep users informed about critical news affecting their stock portfolio. In today's fast-paced market, staying updated on relevant information can be overwhelming with a flood of news from various sources.
- Host: GitHub
- URL: https://github.com/xoxoharsh/red_alert
- Owner: XoXoHarsh
- Created: 2024-04-20T04:04:16.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-21T09:19:27.000Z (about 1 year ago)
- Last Synced: 2025-02-24T03:42:55.303Z (3 months ago)
- Topics: full-stack, news, notification, prediction, stock-market
- Language: Jupyter Notebook
- Homepage:
- Size: 8.27 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Red Alert
## Project Description:
Red Alert is a notification system designed to keep users informed about critical news affecting their stock portfolio. In today's fast-paced market, staying updated on relevant information can be overwhelming with a flood of news from various sources. Red Alert streamlines this process by delivering timely notifications for important articles directly to users, eliminating the need for constant monitoring of multiple platforms.
## Key Features:
**Personalized Notifications:** Users receive notifications tailored to their specific stock portfolio, ensuring they stay informed about relevant news.
**AI/ML Integration:** Leveraging advanced Artificial Intelligence and Machine Learning algorithms, Red Alert identifies and prioritizes news articles based on their potential impact on the user's investments.
**Efficient Information Delivery:** Red Alert minimizes information overload by delivering only the most critical news articles, allowing users to focus on key updates without sifting through countless irrelevant sources.
**MERN Stack:** The application is built using the MERN (MongoDB, Express.js, React.js, Node.js) stack, providing a robust and scalable foundation for development.
## How It Works:
**User Profile Setup:** Users create a profile and input their stock portfolio details.
**AI Analysis:** Red Alert's AI algorithms continuously monitor news sources and analyze articles to identify those relevant to the user's portfolio.
**Notification Delivery:** When significant news is detected, Red Alert sends a notification to the user's preferred device, ensuring timely access to important information.
## Benefits:
**Stay Ahead in the Game**: User will be a step ahead in gaining relevant information about there stock portfolio among other retail investors.
**Time Saving**: User would not have to read irrelevant articles about the things that they do not need to worry about.
**Decision Making**: Showing only the news with priority level will not manipulate the user about a certain stock, it will give the user the ability to read the articile and make decision of buying and selling themselves.
## Why Red Alert?
**Save Time:** No need to constantly monitor multiple news sources for updates.
**Stay Informed:** Receive timely notifications about critical news affecting your investments.
**Personalized Experience:** Tailored notifications ensure relevance to your specific stock portfolio.
**Efficiency:** Focus on essential updates without getting overwhelmed by irrelevant information.
## Tech Stack Used
- **React** - To build dynamic frontend to capability to render dynamically
- **Express** - To build the REST APIs with protected routes using JWT and verification mail to avoid fake accounts.
- **Node** - For overrall javascript run time enviornment, used on both frontend and backend
- **MongoDB** - Nosql database to store user information
- **AI/Ml** - debert-v3-base and distilBert-base-uncased(for tokenization for news articles), bloom560m(for multilabel classification of news to get priority).
## How to use the Project
- Clone the project
- Install all the dependencies in frontend and backend folder using npm install command from your console.
- Create your .env files in both frontend and backend
- Inside your frontend .env write VITE_SERVER_URL=(something if you want to host) and VITE_LOCALHOST = http://localhost:8000
- Inside your backend .env write PORT=8000, EMAIL_ID= Your email (for verification mail during sign up), APP_PASSWORD = (password of your google email service for nodemailer), CORS_ORIGIN = http://localhost:5173, MONGODB_URI = )(mongodb atlas url), JWT_SECRET = 1234 (JWT Token for your)
- Run the frontend and backend using npm run dev command from console.
## Contributors of the Project
- [Harsh Sharma](https://github.com/HarshSharma20503)
- [Ayush Gupta](https://github.com/skywalker290)
- [Nandini Agrawal](https://github.com/NandiniAgrawal15)
- [Saksham Sahgal](https://github.com/SakshamSahgal)