https://github.com/charlestang06/finsight
Your personalized AI finance bro, Finn. Dashboard + learning tools to get started with investing in stock markets.
https://github.com/charlestang06/finsight
ant-design fastapi firebase firebase-auth huggingface langchain ollama reactjs yfinance
Last synced: 5 months ago
JSON representation
Your personalized AI finance bro, Finn. Dashboard + learning tools to get started with investing in stock markets.
- Host: GitHub
- URL: https://github.com/charlestang06/finsight
- Owner: charlestang06
- License: mit
- Created: 2024-03-30T15:27:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-31T15:43:53.000Z (over 1 year ago)
- Last Synced: 2025-02-17T09:19:46.771Z (8 months ago)
- Topics: ant-design, fastapi, firebase, firebase-auth, huggingface, langchain, ollama, reactjs, yfinance
- Language: JavaScript
- Homepage:
- Size: 3.62 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Finsight 📈
## Your AI finance bro, Finn
## About
Finsight is a RAG (retrieval augmented generation) AI app that helps new investors understand financial markets through experiential learning. With market data streamed from Yahoo Finance, state-of-the-art LLMs (large language models) process that data and deliver high-quality, unbiased market briefings to users through a friendly user interface.
## Our Process
We were motivated by the difficulty of learning more about the stock and financial markets, as they are taking a bigger role in our day-to-day wealth management lives. So, we determined a need for an educational platform to help new investors understand what the financial market looks like daily and provide critical insights on investments. As a result, Finsense came to be. We spent the first few hours planning our idea, including developing our unique “RAG” pipeline from data sources like Yahoo Finance to LLMs to the user interface with LangChain wrappers. We also sketched our idea on a whiteboard while researching similar designs: Yahoo Finance, Robinhood, Motley Fools, etc.
## Current Features
- Top company stock listings dashboard for users to explore and add to their "favorites"
- In-depth RAG-generated stock briefings for day, month, quarter, and year
- User login for saving favorites
- Tutorial and definitions to help users learn about financial terms
### Future Work
- Deploy to a permanent cloud location and custom domain
- Experiment with different LLMs and Prompt Templates to improve response quality
- Streaming tokens for cleaner chat UI
## Technical
Finsense was developed with the following technologies:
- Frontend: ReactJS
- API: FastAPI, HuggingFace LLM (gemma:2b, published on Feb 21, 2024), Ollama, LangChain
- Database: Firebase Firestore
- Auth: Firebase Auth
### Local Hosting
To run the project locally, you may clone the repository linked above. You must have Node version 18+ and pip/Python 3.11+ installed on your machine.
**Setup**
```bash
git clone https://github.com/charlestang06/finsight
```
Then, install the dependencies.
```bash
cd web-app
npm install
cd ..
cd finance-rag-server
pip install -r requirements.txt
```
Run the server. The server will be listening on port 8000.
```bash
cd finance-rag-server
uvicorn main:app --reload
cd ..
```
Open a new command line and run the web-app.
```bash
cd web-app
npm start
```
Go to `localhost:3000` to view the project.
### Versions
* Version 1.0 (03/30/2024)
* Initial Release
* See [Commits history]
### License
MIT