Welcome 👋

This is a generative UI financial agent.

We use Vercel's AI SDK and LangChain agents to dynamically answer and render UI.

In addition, we use the financial datasets stock market API to get real-time stock data and in-depth financials.

Finally, for general web search, we use the Tavily search API.

Getting Started 🚀

1. Download the repo locally:

   git clone https://github.com/virattt/financial-agent-ui.git
   

2. Create a .env file in the root project directory (next to .env.example) and add the following:

   OPENAI_API_KEY=               # Get one at https://platform.openai.com
   FINANCIAL_DATASETS_API_KEY=   # Get one at https://financialdatasets.ai
   TAVILY_API_KEY=               # Get one at https://tavily.com
   

Run the agent

We strongly recommend using Docker to run the application. This will ensure that all dependencies are installed and the application runs smoothly.

You can find Docker installation instructions here.

Once installed, run the following command in the root project directory to start the application:

 docker-compose up

If you don't want to use Docker, then you can manually install the application.

• To run the backend server, instructions are here.
• To run the frontend app, instructions are here.

Disclaimer 🛑

The goal of this application is only to explore generative AI and UI.

This financial agent is not intended as financial advice. It is designed to provide users with tools and information to explore technical concepts with respect to generative AI only. Users should conduct their own research or consult with a financial advisor before making any financial decisions.

Contributing 👷‍♂️

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License 📜

This project is licensed under the MIT License.

Contributors ❤️