Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sandramsc/finpal
FinPAL - Your Finance Ally
https://github.com/sandramsc/finpal
gemini-ai trulens
Last synced: 7 days ago
JSON representation
FinPAL - Your Finance Ally
- Host: GitHub
- URL: https://github.com/sandramsc/finpal
- Owner: sandramsc
- License: mit
- Created: 2023-12-15T13:34:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2023-12-30T22:24:04.000Z (10 months ago)
- Last Synced: 2023-12-30T23:22:55.303Z (10 months ago)
- Topics: gemini-ai, trulens
- Language: JavaScript
- Homepage: https://finpallandingpage.vercel.app/
- Size: 13.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
FinPAL
FinPAL - Your Telegram Finance Ally
## Application Description
Introducing FinPAL, your dedicated Financial Assistant Telegram bot meticulously crafted to offer unparalleled financial guidance and support. Harnessing the cutting-edge Trulens eval llm monitoring technology, FinPAL is engineered to deliver contextually rich and actionable financial advice. Powered by advanced algorithms and user-friendly functionalities, it stands out with unique features tailored for a seamless user experience.
## Table of Contents
FinPAL
- [Application Description](#application-description)
- [Table of Contents](#table-of-contents)
- [Project Demo](#demo)
- [Screenshots](#screenshots)
- [Technology Stack](#technology-stack)
- [Features](#features)
- [Collaborators](#collaborators)
- [References](#references)
- [License](#license)
## Web App Video Demo
[View the Demo](https://youtu.be/yoyppkJUK7Q)
## Web App
[Landing page](https://finpallandingpage.vercel.app/)
[Dashboard](https://finpaldash.vercel.app/dashboard/user_id/test/start_date/20230101/end_date/20231212)
## Screenshots
## Technology Stack
| Technology | Description |
| ----------- | ------------------------ |
| Material-UI | React UI library |
| TypeScript | Object-oriented language |
| React.js | JavaScript library |
| Python | a high-level, general-purpose programming language |
| FastAPI | a modern web framework for building RESTful APIs in Python |
| Qdrant | a vector similarity search engine |
| Prisma | Next-generation ORM for Node.js & TypeScript |
| Pyrogram | a modern, elegant and asynchronous MTProto API framework. |
| TgCrypto | a Cryptography Library written in C as a Python extension |
| Google Generative AI | a category of artificial intelligence that can create new text, images, video, audio, or code |
| Matplotlib | a comprehensive library for creating static, animated, and interactive visualizations in Python |
| TruLens-Eval | an open source library for evaluating and tracking the performance of LLM apps, such as RAGs. |
## Features
1. FinPAL boasts a sophisticated suite of features designed for seamless financial management.
2. FinPAL with Trulens eval llm monitoring, we have a robust llm monitoring system in place, get automated and measurable feedback on how the llm is performing.
3. Integration with Telegram to ensure effective communication right in user pocket.
4. Ability to save transaction receipts through chat or photo to add a practical touch.
5. Generate transaction charts effortlessly through chat, and smoothly query transaction data for comprehensive financial insights.
## How to use the FinPAL Telegram bot
1. Initiate a conversation with the bot with a text prompt i.e /start command.
2. Participate in financial dialogues with the bot, receiving guidance and responses on personal finance topics.
## How to use the app
**Step #1** - Clone the project
```bash
$ git clone https://github.com/sandramsc/FinPAL.git
```
**Step #2**
- Fill in all .env
- Start docker compose
```
docker compose -f compose.local.yml up
```
- Install dependencies in both frontend and backend folders: `npm i` OR `yarn`
- To start the webapp, run: `npm start` OR `yarn start`
## Authors
| Name | Link |
| --------------- | ------------------------------------------- |
| Sandra Ashipala | https://www.linkedin.com/in/sandraashipala/ |
| Viky Wahjoedin | https://www.linkedin.com/in/vikyweb/ |
## License
[](https://github.com/sandramsc/FinPAL/blob/master/LICENSE.md)